List labels
Changed onClosed beta
See a list of labels for assets that your account owns, and filter the list by different criteria. If no filter is provided, it will default to labels associated with the ad account id.
Request
- Base URLhttps://api.pinterest.com/v5
- AuthOAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesads:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Unique identifier of an ad account.
Query parameters
List of Campaign Ids to use to filter the results.
List of Label Ids to use to filter the results.
Label entity status
Label type.
Cursor used to fetch the next page of items
Maximum number of items to include in a single page. See documentation on Pagination for more information.
Response
The request has succeeded.
Changes
- breaking
the response's body type changed from no type to
objectfor status - info
removed
subschema #2from the response bodyallOflist for the response status - info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the required property
to the response with the status
- breaking
- breaking
the response property
//////became nullable for the status - breaking
the response property
//////became nullable for the status - breaking
the response property
//////became nullable for the status - breaking
the response property
/////became nullable for the status - breaking
the response property
/////became nullable for the status - breaking
the response property
/////became nullable for the status - warning
added the new
ACTIVEenum value to the//////response property for the response status - warning
added the new
ACTIVEenum value to the/////response property for the response status - warning
added the new
ARCHIVEDenum value to the//////response property for the response status - warning
added the new
ARCHIVEDenum value to the/////response property for the response status - warning
added the new
BRANDenum value to the//////response property for the response status - warning
added the new
BRANDenum value to the/////response property for the response status - warning
added the new
CAMPAIGNenum value to the//////response property for the response status - warning
added the new
CAMPAIGNenum value to the/////response property for the response status - warning
added the new
CUSTOMenum value to the//////response property for the response status - warning
added the new
CUSTOMenum value to the/////response property for the response status - warning
added the new
undefinedenum value to the//////response property for the response status - warning
added the new
undefinedenum value to the//////response property for the response status - warning
added the new
undefinedenum value to the//////response property for the response status - warning
added the new
undefinedenum value to the/////response property for the response status - warning
added the new
undefinedenum value to the/////response property for the response status - warning
added the new
undefinedenum value to the/////response property for the response status - info
for the
queryrequest parametercampaign_ids, the maxItems was increased from100to250 - info
for the
queryrequest parameterlabel_ids, the maxItems was increased from100to250
- breaking