SKskydio
k7m2q9w4z1x6b3v8

Get Audit Events

Changed on

Search an organization's audit events.

get/v0/audit_events

Request

  • Base URL
    https://api.skydio.com/api
  • Auth
    API key in header Authorization

Query parameters

actionstring

Limit results to a single audited action (e.g. user.login). Matches the action exactly.

order'asc' | 'desc'

Sort order for results. asc returns oldest-first; desc returns newest-first.

sincestring date-time

Return events with an event time at or after this timestamp. The timestamp should follow the ISO 8601 standard format.

Example:2022-05-03T03:10:52.503+00:00
untilstring date-time

Return events with an event time at or before this timestamp. The timestamp should follow the ISO 8601 standard format.

Example:2022-05-03T03:10:52.503+00:00
cursorstring

Opaque pagination cursor from a previous response's next_cursor. Omit to fetch the first page.

Response

List of audit events returned from the GET /audit_events endpoint

error_messagestring
skydio_error_codeinteger required
status_codeinteger required

Example response

{
  "data": {
    "audit_events": [
      {
        "action": "user.login",
        "created": "2022-05-03T03:10:52.503+00:00",
        "event_time": "2022-05-03T03:10:52.503+00:00",
        "modified": "2022-05-03T03:10:52.503+00:00",
        "payload": {
          "action": "user.login",
          "actor": {
            "email": "holden.apples@example.com",
            "id": "00000000-0000-0000-0000-000000000005"
          },
          "context": {
            "auth_method": "one_time_password",
            "client_key": "web_js_client",
            "first_successful_auth": false,
            "remote_addr": "192.0.2.1",
            "session_id": "00000000-0000-0000-0000-000000000003"
          },
          "description": "user.login by holden.apples@example.com",
          "organization": {
            "id": "00000000-0000-0000-0000-000000000004",
            "name": "Example Organization"
          },
          "targets": [
            {
              "email": "holden.apples@example.com",
              "id": "00000000-0000-0000-0000-000000000005",
              "organization_name": "Example Organization",
              "type": "User"
            }
          ]
        }
      }
    ]
  }
}

Changes