Skip to content

AuditEntries_list

GET
/audit-entries
curl --request GET \
--url 'http://localhost:3000/api/audit-entries?actorKind=user&limit=25' \
--header 'Authorization: Bearer <token>'

List the Workspace’s Audit log, newest first (Enterprise; needs the audit:read scope)

from
string format: date-time

Only entries at or after this time

to
string format: date-time

Only entries strictly before this time

actorKind

Who performed an audited change

string
Allowed values: user api_token staff system

Only entries by this kind of actor

actorId
string

Only entries by the actor with this id (a User id or an API token id); ignored for the staff member kind

action
string

Only entries with exactly this action, e.g. membership.update

targetType
string

Only entries about this target type, e.g. integration

targetId
string

Only entries about the target with this id

ip
string

Only entries from this client address

requestId
string

Only entries made under this request id

cursor
string

Cursor from a previous page

limit
integer format: int32
default: 25

Page size

The request has succeeded.

Media typeapplication/json

A page of Audit entries, newest first

object
items
required
Array<object>

One immutable Audit entry (Enterprise)

object
id
required

Unique identifier

string format: int64
/^[0-9]{1,18}$/
occurredAt
required

When the change happened

string format: date-time
actor
required

Who did it

object
kind
required

The kind of actor; a staff member is shown as “Sphericon staff”

string
Allowed values: user api_token staff system
id

The actor’s id (a User id or an API token id); absent for the system

string
nullable
name

Display name snapshot taken when the entry was written

string
nullable
action
required

What was done, as <entity>.<verb>

string
target
required

What it was done to

object
type
required

Entity type, e.g. membership

string
id

The target’s id

string
nullable
name

Name snapshot taken when the entry was written; absent for a Contact

string
nullable
diff

Before/after of the changed fields; secrets appear as changed only

object
key
additional properties
requestId

Request id of the change

string
nullable
ip

Client address of the change

string
nullable
userAgent

Client user agent of the change

string
nullable
nextCursor

Pass as cursor for the next page; absent on the last page

string
nullable

Example

{
"items": [
{
"actor": {
"kind": "user"
}
}
]
}

RFC 7807 bad request response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example

{
"code": "second_factor_required"
}

RFC 7807 unauthorized response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example

{
"code": "second_factor_required"
}

RFC 7807 payment required response: the feature needs an Enterprise license

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example

{
"code": "second_factor_required"
}

RFC 7807 too many requests response: a rate limit was exceeded (ADR 0025)

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example

{
"code": "second_factor_required"
}
Retry-After
required
integer format: int32

Seconds to wait before retrying

X-RateLimit-Limit
required
integer format: int32

The request budget of the window that was exceeded

X-RateLimit-Remaining
required
integer format: int32

Requests left in the current window

X-RateLimit-Reset
required
integer format: int64

Unix time at which the window resets