PIpinterest
audience_sharing

List accounts with access to an audience owned by an ad account

Changed on

List all ad accounts and/or businesses that have access to a specific audience. The audience must be owned by the requesting ad account.

get/ad_accounts/{ad_account_id}/audiences/shared/accounts

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

audience_idstring required

Unique identifier of the audience to use to filter the results.

account_type'AD_ACCOUNT' | 'BUSINESS_ACCOUNT' required

Account type filter for audience sharing.

Filter accounts by account type.

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.

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "account_id": "549755885175",
      "account_name": "Home Depot USA",
      "shared_on_timestamp": 1677003860
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list 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 optional property to the response with the status

    • info

      added the required property to the response with the status

  • v510f9eba4ad97Revision changes
    • info

      the endpoint scheme security client_credentials was added to the API