PIpinterest
business_access_relationships

Get business partners

Changed on

Get all partners of the specified business.

If the assets_summary=TRUE and:

  • partner_type=INTERNAL, the business assets returned are your business assets the partner has access to.
  • partner_type=EXTERNAL, the business assets returned are your partner's business assets the partner has granted you access to.
get/businesses/{business_id}/partners

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

Query parameters

assets_summaryboolean

Include assets summary in the response if this is true.

The assets summary returns a dictionary representing a summary of the assets for the business user ID, with information like the ad accounts and profiles the user has permissions for and what those permissions are

partner_type'INTERNAL' | 'EXTERNAL'
Example:INTERNAL

Specifies whether to fetch internal or external (shared) partners. If partner_type=INTERNAL, the asset being queried is for accesses the partner has to your business assets. If partner_type=EXTERNAL, the asset being queried is for the accesses you have to the partner's business asset.

partner_idsstring

A list of business partner ids separated by commas used to filter the results. Only partners with the specified ids will be returned.

start_indexinteger

An index to start fetching the results from. Only the results starting from this index will be returned.

sort_ascendingboolean

Sort ascending.

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": [
    {
      "assets_summary": {
        "ad_accounts": [
          {
            "id": "549755885175",
            "permissions": [
              "FINANCE_MANAGER",
              "CATALOGS_MANAGER",
              "AUDIENCE_MANAGER"
            ]
          }
        ],
        "profiles": [
          {
            "id": "549755885175",
            "permissions": [
              "FINANCE_MANAGER",
              "CATALOGS_MANAGER",
              "AUDIENCE_MANAGER"
            ]
          }
        ]
      },
      "business_roles": [
        "BIZ_ADMIN"
      ],
      "created_by_business": {
        "email": "business0101@business.com",
        "id": "549755885175",
        "username": "business0101"
      },
      "created_by_user": {
        "email": "business0101@business.com",
        "id": "549755885175",
        "username": "business0101"
      },
      "created_time": 1646767577816,
      "id": "549755885175",
      "user": {
        "email": "business0101@business.com",
        "id": "549755885175",
        "username": "business0101"
      }
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

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

    • info

      added the new optional query request parameter sort_ascending

    • 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 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

  • v5f9321315766fRevision changes
    • info

      endpoint added