Documentation

Developers

IntroductionAuthentication

Featured Endpoints

Checkouts

Customer Portal

Customer-Sessions

Customers

Discounts

License Keys

Oauth2

Organizations

Products

Issue Funding Endpoints

External Organizations

Repositories

Other Endpoints

Advertisements

List CampaignsGET
Get CampaignGET

Benefits

Checkout-Links

Checkouts

Custom-Fields

Customer Portal

Files

Metrics

Oauth2

Orders

Subscriptions

advertisements

List Campaigns

get
/v1/advertisements/
List active advertisement campaigns for a benefit.
pagequery ParameterintegerDefault: 1Optional
Page number, defaults to 1.
Size of a page, defaults to 10. Maximum is 100.
Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
Successful Response
Creation timestamp of the object.
Last modification timestamp of the object.
textstring
max_pageinteger
The dimensions (width, height) in pixels of the advertisement images.
curl -X GET \
    'https://api.polar.sh/v1/advertisements/?benefit_id=00000000-0000-0000-0000-000000000000' \
    -H "Accept: application/json" \
Responses
{
  "items": [
    {
      "created_at": "2024-12-21T00:00:00.000Z",
      "modified_at": "2024-12-21T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "image_url": "string",
      "image_url_dark": "string",
      "text": "string",
      "link_url": "string"
    }
  ],
  "pagination": {
    "total_count": 0,
    "max_page": 0
  },
  "dimensions": [
    0
  ]
}