PIpinterest
audience_sharing

List accounts with access to an audience owned by a business

Changed on

List all ad accounts and/or businesses that have access to a specific audience. The audience must either be owned by an ad account in the requesting business, or it must have been shared with the requesting business. If the requesting business is not the owner of the audience, only ad accounts owned by the requesting business will be returned.

get/businesses/{business_id}/audiences/shared/accounts

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

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

  • v589c27ed39cfdRevision changes
    • info

      endpoint added