APIHub
Back to Explore

My Business Account Management API

The My Business Account Management API lets you list, create, retrieve, and update Google Business accounts and their associated admins, handle invitations (accept, decline, list), and transfer locations between accounts you manage.

Analytics
none
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

134ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/v1/{name}:decline

Declines the specified invitation.

  • name (path, required) — Required. The name of the account invitation that is being declined. `accounts/{account_id}/invitations/{invitation_id}`
POST

/v1/{name}:transfer

Moves a location from an account that the user owns to another account that the same user administers. The user must be an owner of the account the location is currently associated with and must also be at least a manager of the destination account.

  • name (path, required) — Required. The name of the location to transfer. `locations/{location_id}`.
GET

/v1/{parent}/admins

Lists all of the admins for the specified location.

  • parent (path, required) — Required. The name of the location to list admins of. `locations/{location_id}/admins`.
POST

/v1/{parent}/admins

Invites the specified user to become an administrator for the specified location. The invitee must accept the invitation in order to be granted access to the location. See AcceptInvitation to programmatically accept an invitation.

  • parent (path, required) — Required. The resource name of the location this admin is created for. `locations/{location_id}/admins`.
GET

/v1/accounts

Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.

  • filter (query) — Optional. A filter constraining the accounts to return. The response includes only entries that match the filter. If `filter` is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filter `type=USER_GROUP` will only return user groups. The `type` field is the only supported filter.
  • pageSize (query, limit) — Optional. How many accounts to fetch per page. The default and maximum is 20.
  • pageToken (query) — Optional. If specified, the next page of accounts is retrieved. The `pageToken` is returned when a call to `accounts.list` returns more results than can fit into the requested page size.
  • parentAccount (query) — Optional. The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return `ListAccounts` for the authenticated user. `accounts/{account_id}`.
POST

/v1/accounts

Creates an account with the specified name and type under the given parent. - Personal accounts and Organizations cannot be created. - User Groups cannot be created with a Personal account as primary owner. - Location Groups cannot be created with a primary owner of a Personal account if the Personal account is in an Organization. - Location Groups cannot own Location Groups.

DELETE

/v1/{name}

Removes the specified admin as a manager of the specified location.

  • name (path, required) — Required. The resource name of the admin to remove from the location.
GET

/v1/{name}

Gets the specified account. Returns `NOT_FOUND` if the account does not exist or if the caller does not have access rights to it.

  • name (path, required) — Required. The name of the account to fetch.
PATCH

/v1/{name}

Updates the Admin for the specified location. Only the AdminRole of the Admin can be updated.

  • name (path, required) — Immutable. The resource name. For account admins, this is in the form: `accounts/{account_id}/admins/{admin_id}` For location admins, this is in the form: `locations/{location_id}/admins/{admin_id}` This field will be ignored if set during admin creation.
  • updateMask (query) — Required. The specific fields that should be updated. The only editable field is role.
  • validateOnly (query) — Optional. If true, the request is validated without actually updating the account.
POST

/v1/{name}:accept

Accepts the specified invitation.

  • name (path, required) — Required. The name of the invitation that is being accepted. `accounts/{account_id}/invitations/{invitation_id}`
GET

/v1/{parent}/invitations

Lists pending invitations for the specified account.

  • parent (path, required) — Required. The name of the account from which the list of invitations is being retrieved. `accounts/{account_id}/invitations`
  • filter (query) — Optional. Filtering the response is supported via the Invitation.target_type field.

11 endpoints auto-detected

curl -X POST \
  "https://mybusinessaccountmanagement.googleapis.com/v1/{name}:decline"

mybusinessaccountmanagement.googleapis.com · HTTPS only