Ads API •References / businesses / Get pending business invitations

Get pending business invitations

Retrieves all pending invitations for a given business. Only users with ADS_BUSINESS_MEMBER_VIEW_ALL permission can access this endpoint.

Request

business_idstring [uuid]
Required
A unique identifier for the entity.
Example: ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a

Response

List of all pending business invitations.

- business_invitation_idstring [uuid]
- email_addressstring
  The email address of a user in or invited to a business.
  Maximum length: 319Example: "discovery@gmail.com"
- rolestring
  The role of the user in a business.
  Allowed values: "BUSINESS_ADMIN", "BUSINESS_MEMBER"
- An invitation to join an ad account with a specific role.
  ad_account_idstring [uuid]
  Required
  A unique identifier for the entity.
  Example: "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a"
  rolestring
  Required
  The role of a user in an ad account.
  Allowed values: "AD_ACCOUNT_ADMIN", "AD_ACCOUNT_CONTRIBUTOR", "AD_ACCOUNT_VIEWER"

Response sample

{  "business_invitations": [    {      "business_invitation_id": "string",      "email_address": "discovery@gmail.com",      "role": "BUSINESS_ADMIN",      "ad_account_invitations": [        {          "ad_account_id": "ce4ff15e-f04d-48b9-9ddf-fb3c85fbd57a",          "role": "AD_ACCOUNT_ADMIN"        }      ]    }  ]}