Skip to content
Ads APIReferences / Campaigns / Get Campaigns

Get Campaigns

Returns a list of all available campaigns

Request

POST
/campaigns
  • organization_ids
    array of strings
  • ad_account_ids
    array of strings
  • campaign_ids
    array of strings
  • limit
    integer [int32]
    Example value: 2
  • offset
    integer [int32]
    Example value: 0

Response

    • advertiser_id
      string [uuid]

      The unique ID returned when a new advertiser is created.

    • created_on
      string [date-time]

      Date the advertiser was created Time is in ISO-8601 format.

    • ad_set_ids
      array of strings

      IDs associated with the ad set.

    • id
      string [uuid]

      ID associated with the campaign that will contain one to many ad sets within it.

    • name
      string

      Name given to identify your campaign.

    • status
      string [campaign-status]
      Example value: "ACTIVE"Allowed values: "UNSET", "ACTIVE", "PAUSED", "ARCHIVED", "UNRECOGNIZED"
    • version
      integer [int64]

      When a campaign is created or updated, it is assigned a new version.

Response sample

{  "campaigns": [    {      "advertiser_id": "za66a2eb-35cf-46a4-8d2e-0j95dfc133r4",      "created_on": "2022-02-07T21:00:00Z",      "ad_set_ids": ["4ec2568b-0b72-11e8-a7af-52010a800891"],      "id": "2g5488b7-0a48-4751-b3b8-701df2d8cd91",      "name": "Spotify Ads Summer Campaign 2022",      "status": "ACTIVE",      "version": 1    },    {      "advertiser_id": "za66a2eb-35cf-46a4-8d2e-0j95dfc133r4",      "created_on": "2022-02-07T21:00:00Z",      "ad_set_ids": ["4ec2568b-0b72-11e8-a7af-52010a800891"],      "id": "2g5488b7-0a48-4751-b3b8-701df2d8cd91",      "name": "Spotify Ads Summer Campaign 2022",      "status": "ACTIVE",      "version": 1    }  ]}