Sign in
catalogs

List catalogs

Fetch catalogs owned by the "operation user_account".

  • By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an <code>ad_account_id</code> (obtained via <a href='/docs/api/v5/#operation/ad_accounts/list'>List ad accounts</a>) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following <a href="https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access</a> roles on the ad_account: Owner, Admin, Catalogs Manager.

<a href='/docs/shopping/catalog/'>Learn more</a>

get/catalogs

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information.

ad_account_idstring

Unique identifier of an ad account.

Response

Success

bookmarkstring nullable

Example response

{
  "items": [
    {
      "created_at": "2022-03-14T15:15:22Z",
      "id": "864344156814050986",
      "updated_at": "2022-03-14T15:16:34Z"
    }
  ]
}

Changes