Download an organization's events record as JSON lines

GET

/v1/accounts/{account_id}/events:export

curl --request GET \
  --url https://example.com/v1/accounts/example/events:export \
  --header 'X-API-Key: <X-API-Key>'

Every event the organization’s record holds, in record order: its workspaces’ (deleted ones included), as the Events API returns them, one per line. Events past the organization’s retention window are not in the record and not in the download.

The download is the record as of the request. A download that breaks partway ends without its final chunk, never as a shorter file that looks whole: retry it.

Authorizations

• ApiKey
• Bearer

Parameters

Path Parameters

account_id

required

The organization’s UUID, or - for the API key’s own

string

The organization’s UUID, or - for the API key’s own

Query Parameters

start_time

RFC 3339; events created at or after it

string | null

RFC 3339; events created at or after it

end_time

RFC 3339; events created before it

string | null

RFC 3339; events created before it

Responses

200

One qualia.v1 Event as protojson per line, oldest first. Personal data: member events carry usernames and emails.

Media type application/jsonl

string

Example ^generated

example

401

Invalid or missing credentials

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

403

Not an admin of the organization

422

A malformed or empty time range

503

The events record is unavailable