Team Audit Logs
The /audit/logs
endpoint returns a list of audit events generated for your team. The complete list of all the audit events is available on our [Learning Center] page.
The API response contains an array named trails
which contains the details for each audit event such as what was the action, who performed the action, when was it performed, etc.
Requires API Key as
X-Api-Key
request header orapikey
URL query parameter.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
since | string | String. Fetch audit logs created after the given time, in ISO 8601 UTC format (yyyy-mm-ddThh:mm:ss[.mmm]Z). | |
until | string | String. Fetch audit logs created before the given time, in ISO 8601 UTC format (yyyy-mm-ddThh:mm:ss[.mmm]Z). | |
limit | string | Integer. The maximum number of audit events to fetch at once. The maximum possible value is 300. | |
cursor | string | Integer. The cursor to fetch the next set of audit events. |
RESPONSES
status: OK
{"trails":[{"id":1234567,"ip":"12.34.45.67","userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Safari/605.1.15","action":"team.update_user_roles","timestamp":"2021-12-17T09:05:23.000Z","message":"Alice updated roles for multiple users.","data":{"actor":{"name":"Alice","username":"alice","id":734851,"active":true},"team":{"name":"Alice in Wonderland","id":1},"variables":{"users":{"1234":["admin","community-manager","user","super-admin"],"5678":["community-manager","user"]}}}}],"nextCursor":1234567890}