PIpinterest
business_access_invite

Get invites/requests

Changed on

Get the membership/partnership invites and/or requests for the authorized user.

get/businesses/{business_id}/invites

Request

Path parameters

business_idstring required

Unique identifier of the requesting business.

Query parameters

is_memberboolean

A boolean field to indicate whether the invite is to create a partnership or a membership.

invite_statusInviteFilterStatus[]

A list of invite statuses to filter invites by. Only invites whose status is in the provided statuses will be returned.

invite_type'MEMBER_INVITE' | 'PARTNER_INVITE' | 'PARTNER_REQUEST'

The type of invite. MEMBER_INVITE invites a member to access your business assets. PARTNER_INVITE invites a partner to access your business assets. PARTNER_REQUEST requests access to a partner's business assets.

Example:MEMBER_INVITE

Invite type to filter invites by. Only invites of the specified type 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": [
    {
      "assets_summary": {
        "ad_accounts": [
          {
            "permissions": [
              "FINANCE_MANAGER",
              "CATALOGS_MANAGER",
              "AUDIENCE_MANAGER"
            ]
          }
        ],
        "profiles": [
          {
            "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": "383791336903426391",
      "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

      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