Method: accounts.invitations.list

  • This endpoint retrieves pending invitations for a specified Google My Business account.

  • It allows filtering by target type (Account or Location) using the targetType query parameter.

  • The response includes a list of invitations with details, limited to a maximum of 1000.

  • Authorization is required using specific OAuth scopes related to business management.

  • This endpoint is deprecated; consider using the Account Management API instead.

Lists pending invitations for the specified account.

HTTP request

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*}/invitations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The name of the account from which the list of invitations is being retrieved.

Query parameters

Parameters
targetType

enum (TargetType)

Specifies which target types should appear in the response.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for AccessControl.ListInvitations.

JSON representation 
{
  "invitations": [
    {
      object (Invitation)
    }
  ]
}
Fields
invitations[]

object (Invitation)

A collection of location invitations that are pending for the account. The number of invitations listed here cannot exceed 1000.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.

TargetType

The type of target an invitation is for.

Enums
ALL List invitations for all target types. This is the default.
ACCOUNTS_ONLY List invitations only for targets of type Account.
LOCATIONS_ONLY List invitations only for targets of type Location.