Get Audit Events
Get a list of audit events in an organization that satisfies the query criteria.
URL
GET https://api-business.apple.com/v1/auditEventsQuery Parameters
| Name | Type | Description |
|---|---|---|
filter[startTimestamp] Required | [string] | ISO8601 formatted start timestamp of query time range. |
filter[endTimestamp] Required | [string] | ISO8601 formatted end timestamp of query time range. |
filter[actorId] Optional | [string] | Id of actor of event. Note that only one actor id in query is supported. |
filter[subjectId] Optional | [string] | Id of subject of event. Note that only one subject id in query is supported. |
filter[type] Optional | [string] | Type of event. Note that only one type in query is supported. |
limit Optional | integer | The number of included related resources to return. |
fields[auditEvents] Optional | [string] | |
cursor Optional | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | AuditEventsResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 429 | Content-Type: application/json | ErrorResponse | Too Many Requests |