PIpinterest
business_access_assets

Get assets assigned to a partner or assets assigned by a partner

Changed on

Can be used to get the business assets your partner has granted you access to or the business assets you have granted your partner access to. If you specify:

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

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

partner_idstring required

The partner id to be bound to the Business

Query parameters

partner_type'INTERNAL' | 'EXTERNAL'

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.

asset_type'AD_ACCOUNT' | 'PROFILE' | 'ASSET_GROUP' | 'PINNER_LIST' | 'CONVERSION_TAG' | 'CATALOG' | 'CONSUMER' | 'CONVERSION_SEGMENT'

A resource type to filter the assets by. Only assets of the specified type will be returned.

start_indexinteger

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

sort_by'NAME' | 'ID' | 'PERMISSIONS'

The field to sort member assets by

Example:NAME
sort_ascendingboolean

Sort assets in ascending order

search_by'NAME' | 'ID' | 'NAME_OR_ID' | 'OWNER_NAME' | 'NAME_OR_OWNER'

The field to search member assets by

Example:NAME
search_valuestring

The value to search for

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": [
    {
      "asset_group_info": {
        "ad_accounts_ids": [
          "549755885175"
        ],
        "asset_group_description": "Asset group that has ad accounts used in Canada",
        "asset_group_name": "Canada Ad Accounts",
        "asset_group_types": [
          "LOCATION_OR_LANGUAGE"
        ],
        "catalogs_ids": [
          "4836859046874"
        ],
        "created_by": {
          "email": "business0101@business.com",
          "id": "549755885175",
          "username": "business0101"
        },
        "created_time": 1646767577816,
        "id": "666791336903426391",
        "owner": {
          "email": "business0101@business.com",
          "id": "549755885175",
          "username": "business0101"
        },
        "profiles_ids": [
          "630433785246278264"
        ],
        "updated_time": 1646767577816
      },
      "asset_id": "549755885175",
      "asset_type": "AD_ACCOUNT",
      "permissions": [
        "FINANCE_MANAGER",
        "CATALOGS_MANAGER",
        "AUDIENCE_MANAGER"
      ]
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      the query request parameter partner_type was restricted to a list of enum values

    • breaking

      for the query request parameter partner_type, default value INTERNAL was added

    • breaking

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

    • info

      added the new optional query request parameter search_by

    • info

      added the new optional query request parameter search_value

    • info

      added the new optional query request parameter sort_ascending

    • info

      added the new optional query request parameter sort_by

    • info

      added the new enum value CONVERSION_SEGMENT to the query request parameter asset_type

    • info

      added the new enum value CONVERSION_TAG to the query request parameter asset_type

    • info

      added the new enum value EXTERNAL to the query request parameter partner_type

    • info

      added the new enum value INTERNAL to the query request parameter partner_type

    • info

      added the new enum value PINNER_LIST to the query request parameter asset_type

    • info

      for the query request parameter partner_type, the type was generalized from no type to string

    • 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

  • v543134ca41f18Revision changes
    • info

      added the new enum value CONSUMER to the query request parameter asset_type