Skip to content

Get Object Audit Log

GET
/objects/{object_slug}/audit

Who did what, when, to this object’s records, newest first.

Discloses actor activity, so it needs the app’s separate audit permission as well as objects:read. The credential sees only what its own grants and field visibility allow: before/after values of hidden fields are removed and an update of hidden fields only is absent.

Authorizations

Parameters

Path Parameters

object_slug
required
string

Query Parameters

record_id
Any of:
string format: uuid

Limit to one record of this object (404 if not its).

action
Any of:
string
<= 100 characters

Only this action, e.g. create.

limit
integer
default: 100 >= 1 <= 500
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

Response for an object’s audit log (GET /objects/{slug}/audit).

object
entries
required
Array<object>

One cb_record_provenance row: who did what to a record, and when.

object
action
required
string
contributed_at
required
string format: date-time
contributed_by_role_at_time
required
Any of:
string
contributed_by_user_id
required
Any of:
string
contributed_by_user_name
required
Any of:
string
entry_metadata
Any of:
object
key
additional properties
any
id
required
string format: uuid
record_id
required
string format: uuid
limit
required
integer
offset
required
integer
total
integer
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string