PIpinterest
business_access_assets

Get assets assigned to a member

Changed on

Get assets on which you assigned asset permissions to the given member. Can be used to:

  • get all assets, regardless of asset type or
  • get assets of one asset type by using the asset_type query. The return response will include the permissions the member has to that asset and the asset type.
get/businesses/{business_id}/members/{member_id}/assets

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    OAuth 2
    Authorization codehttps://www.pinterest.com/oauth/
    Token URLhttps://api.pinterest.com/v5/oauth/token
    Scopesbiz_access:read

Path parameters

business_idstring required

Unique identifier of the requesting business.

member_idstring required

The member id to fetch assets for.

Query parameters

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

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

asset_permission_type'AGGREGATED_PERMISSION' | 'DIRECT_PERMISSION'

Permission aggregation type for asset access

Example:AGGREGATED_PERMISSION

The type of asset permission to filter by

ad_account_statusesNonDraftEntityStatus[]

A list of ad account statuses to filter the assets by. Only used when asset_type is AD_ACCOUNT.

[
  "ACTIVE"
]
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
total_data_countinteger required

Total number of assets matching the query

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

      added the new optional query request parameter ad_account_statuses

    • info

      added the new optional query request parameter asset_permission_type

    • 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_TAG to the query request parameter asset_type

    • 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 optional property to the response with the status

    • info

      added the required 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