List campaigns

get

https://api.delivr.ai/api/v1/campaigns

Retrieve campaigns. At least one of organization_id, project_id, or
integration_id is required. The response shape depends on whether
pagination is requested:

With limit or offset: returns { data, total_count }.
Without: returns a plain JSON array.

Six parameters are answered only under project_id: limit, offset, sort_by,
sort_order, query and status. Naming any of them alongside organization_id or
integration_id is refused with 400 rather than ignored, because the queries behind those
two scopes read none of them: accepting one and dropping it would answer a narrower
question with a wider set of rows and nothing saying so.

The source and active filters are the other way round and apply under
organization_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

organization_id

uuid

Filter by organization ID (UUID).

project_id

uuid

Filter by project ID (UUID). Required to use pagination.

integration_id

uuid

Filter by integration ID (UUID).

source

string

Filter by source. Free-form string; common values include
delivrdsp. Only applied when filtering by organization_id.

active

boolean

When true, return only active campaigns. Only applied when filtering by organization_id.

query

string

Search by campaign name (case-insensitive partial match). Requires project_id (see below).

status

string

Filter by campaign status. Requires project_id (see below).

Accepts a comma-separated list, a repeated key, or both, and matches any of the values given. The vocabulary is deliberately open, because the column is written both by the launch lifecycle here and by the ad platform on sync, so a status either side adds works immediately. An unknown value therefore matches nothing and returns an empty page rather than an error. A value that names nothing at all, such as a bare comma, is refused instead, since reading it as no filter would widen the answer to every campaign while you believed you had narrowed it.

limit

integer

≤ 1000

Page size, up to 1000. Requires project_id (see below).

Sending limit or offset is what selects the paginated response shape; omit both and the endpoint returns every matching campaign in the unpaginated shape. There is no default for that reason: absent is a different response, not this value. Within the paginated shape a limit omitted alongside an offset resolves to 25.

offset

integer

Rows to skip. Requires project_id (see below). Selects the paginated response shape, as limit does, and resolves to 0 within it.

sort_by

string

enum

Defaults to created_at

Sort by field. Requires project_id (see below).

Allowed:

sort_order

string

enum

Defaults to desc

Sort direction. Requires project_id (see below).

Allowed:

Responses

401

Missing or invalid authentication.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of campaigns. Schema depends on whether pagination was requested.

400Missing required filter or invalid ID format.