PIpinterest
business_access_relationships

List business employers for user

Changed on

Get all of the viewing user's business employers.

get/businesses/employers

Request

Query parameters

assets_summaryboolean

Include assets summary in the response if this is true. Defaults to 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

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 assets_summary

    • 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