Skip to content
Ads APIReferences / Advertiser / Get Advertisers

Get Advertisers

Returns a list of available advertisers.

Request

POST
/advertisers
  • organization_ids
    array of strings
  • ad_account_ids
    array of strings
  • advertiser_ids
    array of strings
  • limit
    integer [int32]
    Example: 2
  • offset
    integer [int32]
    Example: 0

Response

    • created_on
      string [date-time]
      Required

      Date the advertiser was created. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ

      Example: "2022-11-06T14:48:00Z"
    • description
      string
      Required

      Descriptor for the advertiser.

      Example: "New Advertiser"
    • id
      string [uuid]
      Required

      The Unique ID returned back when a new advertiser is created.

    • name
      string
      Required

      Advertiser name that will be displayed to the user

      Example: "Stageside Ticketing"
    • version
      integer [int64]
      Required

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

      Example: 1

Response sample

{  "advertisers": [    {      "created_on": "2022-11-06T14:48:00Z",      "description": "New Advertiser",      "id": "za66a2eb-35cf-46a4-8d2e-0j95dfc133r4",      "name": "Stageside Ticketing",      "version": 1    },    {      "created_on": "2022-11-06T14:48:00Z",      "description": "New Advertiser",      "id": "za66a2eb-35cf-46a4-8d2e-0j95dfc133r4",      "name": "Stageside Ticketing",      "version": 1    }  ]}