List exports

Returns a page of the exports in your organization, narrowed to the scope you name. The organization always comes from the API key.

Name at least one scope: project_id, integration_id, campaign_id or audience_id. If you name more than one, only one is used, in this order of precedence: campaign_id, audience_id, project_id, integration_id.

Which options apply depends on the scope. An option the scope cannot apply is refused with 400, never silently ignored.

  • query, sort_by and sort_order: with project_id, integration_id, or only organization_id.
  • last_run_status, enabled and auto_disabled: with project_id only.
  • With campaign_id or audience_id, only the scope and paging apply.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Exports in this project (UUID). Preferred scope.

uuid

Exports delivered through this integration (UUID).

string

Exports linked to this campaign.

string

Exports built from this audience.

uuid

Optional. The organization is taken from the API key; if you send this it must be the key's own organization.

string

Search by export name.

string
enum
Defaults to created_at

Field to sort by. An unrecognized value returns 400.

Allowed:
string
enum

Sort direction.

Allowed:
boolean
Defaults to false

Include archived exports. Off by default.

string
enum

Only exports whose last run ended in this state. never selects exports that have never run. Project scope only.

Allowed:
boolean

Only exports that are enabled (true) or disabled (false). Project scope only.

boolean

Only exports the platform disabled automatically (true) or not (false). Project scope only.

integer
1 to 1000
Defaults to 1000

Page size, 1 to 1000. A larger value is reduced to 1000.

integer
≥ 0
Defaults to 0

Number of exports to skip.

Responses

401

Missing or invalid API key / secret.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json