catalog_feeds

Get feed

Get a single feed owned by the "operation user_account".

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

Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) 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 Business Access roles on the ad_account: Owner, Admin, Catalogs Manager.

For Retail partners, refer to Before you get started with Catalogs. For Hotel partners, refer to Pinterest API for shopping.

get/catalogs/feeds/{feed_id}

Path parameters

feed_idstring required

Unique identifier of a feed.

Query parameters

ad_account_idstring

Unique identifier of an ad account.

Response

The request has succeeded.

OR
OR

Example response

{
  "id": "864344156814050986"
}

Changes

Changed in 10 of the 29 revisions of this API.3463

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property oneOf[subschema #1: catalogs_retail_feed]/credentials to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: catalogs_retail_feed]/default_availability to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: catalogs_retail_feed]/default_currency to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #1: catalogs_retail_feed]/preferred_processing_schedule to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: catalogs_hotel_feed]/credentials to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: catalogs_hotel_feed]/default_currency to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #2: catalogs_hotel_feed]/preferred_processing_schedule to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #3: catalogs_creative_assets_feed]/credentials to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #3: catalogs_creative_assets_feed]/default_currency to the response with the 200 status

      response-optional-property-added

    • added the optional property oneOf[subschema #3: catalogs_creative_assets_feed]/preferred_processing_schedule to the response with the 200 status

      response-optional-property-added

    • removed CatalogsDbItem subschema #2: feed_fields from the oneOf[subschema #1: catalogs_retail_feed]/ response property allOf list for the response status 200

      response-property-all-of-removed

    • removed CatalogsDbItem subschema #2: feed_fields from the oneOf[subschema #2: catalogs_hotel_feed]/ response property allOf list for the response status 200

      response-property-all-of-removed

    • removed CatalogsDbItem subschema #2: feed_fields from the oneOf[subschema #3: catalogs_creative_assets_feed]/ response property allOf list for the response status 200

      response-property-all-of-removed

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/catalog_type to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/created_at to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/default_country to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/default_locale to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/format to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/id to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/location to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/name to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/status to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #1: catalogs_retail_feed]/updated_at to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/catalog_id to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/catalog_type to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/created_at to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/default_locale to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/format to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/id to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/location to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/name to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/status to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #2: catalogs_hotel_feed]/updated_at to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/catalog_id to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/catalog_type to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/created_at to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/default_country to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/default_locale to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/format to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/id to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/location to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/name to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/status to the response with the 200 status

      response-required-property-added

    • added the required property oneOf[subschema #3: catalogs_creative_assets_feed]/updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api tag catalog_feeds added

      api-tag-added

    • api tag catalogs removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the endpoint scheme security client_credentials was added to the API

      api-security-added

    • the response property oneOf[subschema #1: catalogs_retail_feed]/allOf[subschema #1: db_item]/created_at became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #1: catalogs_retail_feed]/allOf[subschema #1: db_item]/id became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #1: catalogs_retail_feed]/allOf[subschema #1: db_item]/updated_at became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #2: catalogs_hotel_feed]/allOf[subschema #1: db_item]/created_at became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #2: catalogs_hotel_feed]/allOf[subschema #1: db_item]/id became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #2: catalogs_hotel_feed]/allOf[subschema #1: db_item]/updated_at became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #3: catalogs_creative_assets_feed]/allOf[subschema #1: db_item]/created_at became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #3: catalogs_creative_assets_feed]/allOf[subschema #1: db_item]/id became required for the status 200

      response-property-became-required

    • the response property oneOf[subschema #3: catalogs_creative_assets_feed]/allOf[subschema #1: db_item]/updated_at became required for the status 200

      response-property-became-required

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5f9321315766f121See the full diff
    • added CatalogsCreativeAssetsFeed to the response body oneOf list for the response status 200

      response-body-one-of-added

    • added the new CREATIVE_ASSETS enum value to the oneOf[subschema #1: catalogs_retail_feed]/allOf[subschema #2: feed_fields]/catalog_type response property for the response status 200

      response-property-enum-value-added

    • added the new CREATIVE_ASSETS enum value to the oneOf[subschema #2: catalogs_hotel_feed]/allOf[subschema #2: feed_fields]/catalog_type response property for the response status 200

      response-property-enum-value-added

    • added CREATIVE_ASSETS mapping keys to the response discriminator for the response status 200

      response-body-discriminator-mapping-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v50ff12596bafd12See the full diff
    • added CatalogsRetailFeed CatalogsHotelFeed to the response body oneOf list for the response status 200

      response-body-one-of-added

    • removed CatalogsDbItem subschema #2: feed_fields from the response body allOf list for the response status 200

      response-body-all-of-removed

    • added response discriminator for the response status 200

      response-body-discriminator-added

    • added the new CN enum value to the allOf[subschema #2: feed_fields]/default_country response property for the response status 200

      response-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional query request parameter ad_account_id

      new-optional-request-parameter

    • added the new path request parameter feed_id

      new-request-path-parameter

    • deleted the path request parameter feed_id

      request-parameter-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added