Loading...
Skip to main content

Get an audit event

Fetch a specific audit event by ID.

URL: https://api.courier.com/audit-events/:audit-event-id

Method: GET

Path Parameters

audit-event-idstringrequired
A unique identifier associated with the audit event you wish to retrieve

Response

status: 200 OK

auditEventIdstring
A unique identifier associated with the audit event you wish to retrieve
actorobject
+ Show Properties
targetobject
+ Show Properties
sourcestring
A unique identifier representing the source of the audit event.
timestampstring
A UTC timestamp at which the audit event was triggered.
typestring
The type of audit event that was triggered.

Request Example

curl --request GET \
--url https://api.courier.com/audit-events/ZX3xXUMNKL4y2NkiKgstl \
--header 'Accept: application/json'

Responses Example

{
"auditEventId": "ZX3xXUMNKL4y2NkiKgstl",
"actor": {
"id": "foo-user",
"email": "joe.fake@gmail.com"
},
"target": {
"id": "EF607F6E84A34305AE98B6TR",
"email": "jane.doe@gmail.com"
},
"source": "courier.studio",
"timestamp": "2022-07-05T22:30:24.662Z",
"type": "user:role-changed"
}