Skip to main content
GET
curl

Authorizations

X-Api-Key
string
header
required

Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Query Parameters

limit
integer
required

Maximum number of records to fetch in the current page. Must be between 1 and 100.

Required range: 1 <= x <= 100
offset
integer
required

Number of records to skip before fetching the results.For example, an offset of 0 starts at the beginning, while an offset of 50 fetches records starting from the 51st. If offset is greater than number of records available, results will be empty.

Required range: x >= 0
workspace_id
integer | null
required

Fetch campaigns from this workspace only.

Response

Success

data
object[]
required

List of campaign data.

total
integer
required

Total number of campaigns available in this workspace if workspace_id was provided. Otherwise across all workspaces.

Required range: x >= 0