PIpinterest
schedules

Get Schedules

Changed on

Get schedules for a specific advertiser

get/ad_accounts/{ad_account_id}/schedules

Request

Path parameters

ad_account_idstring required

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

schedule_statusesScheduleStatus[]

Filter schedules by status (one or more)

[
  "ACTIVE"
]
schedule_type'CAMPAIGN_BUDGET_CHANGE' | 'CAMPAIGN_BID_MULTIPLIERS'

The schedule type

Example:CAMPAIGN_BUDGET_CHANGE

Filter schedules by a type

entity_idsEntityId[] required

List of Entity IDs, must be associated with the Ad Accound ID provided in the path.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "entity_type": "CAMPAIGN",
      "schedule_action": "INCREASE_BY_VALUE",
      "schedule_status": "ACTIVE",
      "schedule_type": "CAMPAIGN_BUDGET_CHANGE"
    }
  ]
}

Changes