Skip to main content

๐Ÿ“„ List Campaigns

Returns a list of all campaigns for a company.

๐Ÿ“ค Request Example

curl -X GET https://betaapi.audiohook.com/v2/companies/:companyUUID/campaigns?page=0&size=1 \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "request_headers": [
      { "name": "X-Request-Header", "value": "Header value" }
    ]
  }'

๐ŸŒ HTTP Request

GET /v2/companies/:companyUUID/campaigns

๐Ÿงพ Query Parameters

ParameterDefaultTypeDescription
page0intThe page of campaigns to return.
size100intThe total number of campaigns to be returned.
qNonestringSearch by campaign name.
archivefalsebooleanReturn archived or non-archived campaigns.
statusallstringFilter by status: active-running, active, inactive, or all.
startDate-1stringStart date in Y-M-D format. Defaults to -1 (all).
endDate-1stringEnd date in Y-M-D format. Defaults to -1 (all).
order_byNonestringOrder by a key like name-ORDER.
datatruebooleanInclude impressions, spend, conversions, and cost per conversion.
campaign_ids_dataNonestringComma-separated campaign IDs to include in response.