Skip to content
Purser

List Audit

GET
/audit
curl --request GET \
  --url 'https://example.com/audit?unattributed=false&disclosed=false&order=desc&limit=100'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
kind
Any of:
string
/^(read|write|change)$/
actor_token_id
Any of:
string format: uuid
unattributed
Unattributed
boolean
action
Any of:
string
entity_type
Any of:
string
entity_id
Any of:
string format: uuid
request_id
Any of:
string format: uuid
since
Any of:
string format: date-time
until
Any of:
string format: date-time
disclosed
Disclosed

Only calls that disclosed fields beyond the privacy defaults

boolean

Only calls that disclosed fields beyond the privacy defaults

order
Order
string
default: desc /^(asc|desc)$/
cursor
Any of:
string
limit
Limit
integer
default: 100 >= 1 <= 500

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AuditPage
object
items
required
Items
Array<object>
AuditOut
object
action
required
Action
string
actor_token_id
required
Any of:
string format: uuid
at
required
At
string format: date-time
before_after
required
Any of:
object
key
additional properties
any
detail
required
Any of:
object
key
additional properties
any
disclosed
Any of:
Array<string>
entity_id
required
Any of:
string format: uuid
entity_type
required
Entity Type
string
id
required
Id
string format: uuid
kind
required
Kind
string
request_id
required
Any of:
string format: uuid
next_cursor
required
Any of:
string

Example generated

{
  "items": [
    {
      "action": "example",
      "actor_token_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "at": "2026-04-15T12:00:00Z",
      "before_after": {},
      "detail": {},
      "disclosed": [
        "example"
      ],
      "entity_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "entity_type": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "kind": "example",
      "request_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "next_cursor": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}