PIpinterest
business_access_assets

List business assets

Changed on

Get all the assets the requesting business has access to. This includes assets the business owns and assets the business has access to through partnerships.

get/businesses/{business_id}/assets

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

Query parameters

permissionsPermissionsWithOwner[]

A list of asset permissions used to filter the assets. Only assets where the requesting business has at least one of the specified permissions will be returned.

child_asset_idstring

A child asset unique identifier. Used to fetch asset groups that contain the asset id as a child.

asset_group_idstring

An asset group unique identifier. Used to fetch assets contained within the specified asset group.

asset_type'AD_ACCOUNT' | 'PROFILE' | 'ASSET_GROUP' | 'CATALOG' | 'CONSUMER'

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.

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