1. Docs
  2. API Reference
  3. Get an audit-log export job

Get an audit-log export job

GET/portal/v1/accounts/{accountSlug}/audit-log/identities/export/{id}

Returns one export job. When the job has completed, the response includes a short-lived (15-minute) signed download URL minted fresh on each read — the URL is never persisted, so a swept object cannot hand out a working link.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability audit.viewSecurity

View the account-wide audit log. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

application/json

  • dataExportJobDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

ExportJobDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/audit-log/identities/export/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "surface": "admin",
    "format": "csv",
    "application_id": "00000000-0000-0000-0000-000000000000",
    "environment_id": "00000000-0000-0000-0000-000000000000",
    "row_count": 0,
    "error": "string",
    "created_at": "2026-04-20T12:00:00.000Z",
    "completed_at": "2026-04-20T12:00:00.000Z",
    "expires_at": "2026-04-20T12:00:00.000Z",
    "download_url": "string"
  }
}
 Related endpoints
GETLive-tail identity audit-log events (SSE)
GETQuery identity audit-log events
GETList recent audit-log export jobs
POSTCreate an identity audit-log export job (CSV / NDJSON)
DELETEDelete an audit-log export job
GETGet an identity audit-log row with related events
 Was this page helpful?

Tell us how we can improve this guide.

Canopy