Google Business Profile Business Profile Mybusinessaccountmanagement Accounts API
The Business Profile Mybusinessaccountmanagement Accounts API from Google Business Profile — 7 operation(s) for business profile mybusinessaccountmanagement accounts.
The Business Profile Mybusinessaccountmanagement Accounts API from Google Business Profile — 7 operation(s) for business profile mybusinessaccountmanagement accounts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/google-business-profile:google-business-profile-mybusinessaccountmanagement-accounts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: My Business Account Management API Accounts API
version: v1
description: Generated from Google's published Discovery document for My Business Account Management API (mybusinessaccountmanagement
v1, revision 20261110). 11 operation(s).
contact:
name: Google
url: https://developers.google.com/
termsOfService: https://developers.google.com/terms
externalDocs:
url: https://developers.google.com/my-business/
servers:
- url: https://mybusinessaccountmanagement.googleapis.com
paths:
/v1/accounts:
post:
operationId: mybusinessaccountmanagement.accounts.create
summary: Create accounts
description: 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.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
4XX:
content: &id001
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id001
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
get:
operationId: mybusinessaccountmanagement.accounts.list
summary: List accounts
description: 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.
parameters:
- name: filter
in: query
required: false
description: 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.
schema:
type: string
- name: pageSize
in: query
required: false
description: Optional. How many accounts to fetch per page. The default and maximum is 20.
schema:
type: integer
format: int32
- name: pageToken
in: query
required: false
description: 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.
schema:
type: string
- name: parentAccount
in: query
required: false
description: 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}`.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccountsResponse'
4XX:
content: &id002
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id002
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
/v1/accounts/{accountsId}:
patch:
operationId: mybusinessaccountmanagement.accounts.patch
summary: Patch accounts
description: Updates the specified business account. Personal accounts cannot be updated using this method.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
- name: updateMask
in: query
required: false
description: Required. The specific fields that should be updated. The only editable field is `accountName`.
schema:
type: string
format: google-fieldmask
- name: validateOnly
in: query
required: false
description: Optional. If true, the request is validated without actually updating the account.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
4XX:
content: &id003
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id003
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
get:
operationId: mybusinessaccountmanagement.accounts.get
summary: Get accounts
description: Gets the specified account. Returns `NOT_FOUND` if the account does not exist or if the caller does not
have access rights to it.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
4XX:
content: &id004
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id004
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
/v1/accounts/{accountsId}/invitations/{invitationsId}:decline:
post:
operationId: mybusinessaccountmanagement.accounts.invitations.decline
summary: Decline invitations
description: Declines the specified invitation.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
- name: invitationsId
in: path
required: true
description: Resource name segment (invitationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeclineInvitationRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
4XX:
content: &id005
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id005
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
/v1/accounts/{accountsId}/invitations/{invitationsId}:accept:
post:
operationId: mybusinessaccountmanagement.accounts.invitations.accept
summary: Accept invitations
description: Accepts the specified invitation.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
- name: invitationsId
in: path
required: true
description: Resource name segment (invitationsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptInvitationRequest'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
4XX:
content: &id006
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id006
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
/v1/accounts/{accountsId}/invitations:
get:
operationId: mybusinessaccountmanagement.accounts.invitations.list
summary: List invitations
description: Lists pending invitations for the specified account.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
- name: filter
in: query
required: false
description: Optional. Filtering the response is supported via the Invitation.target_type field.
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListInvitationsResponse'
4XX:
content: &id007
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id007
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
/v1/accounts/{accountsId}/admins:
post:
operationId: mybusinessaccountmanagement.accounts.admins.create
summary: Create admins
description: Invites the specified user to become an administrator for the specified account. The invitee must accept
the invitation in order to be granted access to the account. See AcceptInvitation to programmatically accept an invitation.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Admin'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Admin'
4XX:
content: &id008
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id008
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
get:
operationId: mybusinessaccountmanagement.accounts.admins.list
summary: List admins
description: Lists the admins for the specified account.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccountAdminsResponse'
4XX:
content: &id009
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id009
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
/v1/accounts/{accountsId}/admins/{adminsId}:
delete:
operationId: mybusinessaccountmanagement.accounts.admins.delete
summary: Delete admins
description: Removes the specified admin from the specified account.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
- name: adminsId
in: path
required: true
description: Resource name segment (adminsId).
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
4XX:
content: &id010
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id010
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
patch:
operationId: mybusinessaccountmanagement.accounts.admins.patch
summary: Patch admins
description: Updates the Admin for the specified Account Admin.
parameters:
- name: accountsId
in: path
required: true
description: Resource name segment (accountsId).
schema:
type: string
- name: adminsId
in: path
required: true
description: Resource name segment (adminsId).
schema:
type: string
- name: updateMask
in: query
required: false
description: Required. The specific fields that should be updated. The only editable field is role.
schema:
format: google-fieldmask
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Admin'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Admin'
4XX:
content: &id011
application/json:
schema:
$ref: '#/components/schemas/GoogleRpcError'
description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
default:
content: *id011
description: Error response (google.rpc.Status)
security:
- apiKey: []
tags:
- Accounts
components:
securitySchemes:
apiKey:
type: apiKey
in: query
name: key
description: API key; accepted by methods that do not need user data.
schemas:
AcceptInvitationRequest:
type: object
properties: {}
description: Request message for AccessControl.AcceptInvitation.
Account:
properties:
vettedState:
enum:
- VETTED_STATE_UNSPECIFIED
- NOT_VETTED
- VETTED
- INVALID
type: string
description: Output only. Indicates whether the account is vetted by Google. A vetted account is able to verify
locations via the VETTED_PARTNER method.
readOnly: true
name:
description: Immutable. The resource name, in the format `accounts/{account_id}`.
type: string
type:
description: Required. Contains the type of account. Accounts of type PERSONAL and ORGANIZATION cannot be created
using this API.
type: string
enum:
- ACCOUNT_TYPE_UNSPECIFIED
- PERSONAL
- LOCATION_GROUP
- USER_GROUP
- ORGANIZATION
primaryOwner:
type: string
description: Required. Input only. The resource name of the account which will be the primary owner of the account
being created. It should be of the form `accounts/{account_id}`.
accountName:
type: string
description: Required. The name of the account. For an account of type `PERSONAL`, this is the first and last name
of the user account.
accountNumber:
description: Output only. Account reference number if provisioned.
type: string
readOnly: true
organizationInfo:
$ref: '#/components/schemas/OrganizationInfo'
description: Output only. Additional info for an organization. This is populated only for an organization account.
permissionLevel:
type: string
readOnly: true
description: Output only. Specifies the permission level the user has for this account.
enum:
- PERMISSION_LEVEL_UNSPECIFIED
- OWNER_LEVEL
- MEMBER_LEVEL
verificationState:
type: string
description: Output only. If verified, future locations that are created are automatically connected to Google Maps,
and have Google+ pages created, without requiring moderation.
enum:
- VERIFICATION_STATE_UNSPECIFIED
- VERIFIED
- UNVERIFIED
- VERIFICATION_REQUESTED
readOnly: true
role:
description: Output only. Specifies the AccountRole of this account.
type: string
enum:
- ACCOUNT_ROLE_UNSPECIFIED
- PRIMARY_OWNER
- OWNER
- MANAGER
- SITE_MANAGER
readOnly: true
description: An account is a container for your location. If you are the only user who manages locations for your business,
you can use your personal Google Account. To share management of locations with multiple users, [create a business
account] (https://support.google.com/business/answer/6085339?ref_topic=6085325).
type: object
Admin:
type: object
description: An administrator of an Account or a location.
properties:
role:
type: string
enum:
- ADMIN_ROLE_UNSPECIFIED
- PRIMARY_OWNER
- OWNER
- MANAGER
- SITE_MANAGER
description: Required. Specifies the role that this admin uses with the specified Account or Location.
account:
type: string
description: 'Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create
to invite a LocationGroup as an admin. If both this field and `admin` are set on `CREATE` requests, this field
takes precedence and the email address in `admin` will be ignored. Format: `accounts/{account}`.'
name:
description: '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.'
type: string
admin:
description: Optional. The name of the admin. When making the initial invitation, this is the invitee's email address.
On `GET` calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains
the user's first and last names. This field is only needed to be set during admin creation.
type: string
pendingInvitation:
description: Output only. Indicates whether this admin has a pending invitation for the specified resource.
readOnly: true
type: boolean
DeclineInvitationRequest:
type: object
description: Request message for AccessControl.DeclineInvitation.
properties: {}
Empty:
type: object
description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc
Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }'
properties: {}
GoogleRpcError:
type: object
description: The error envelope every Google API returns.
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
status:
type: string
details:
type: array
items:
type: object
Invitation:
description: Represents a pending invitation.
type: object
properties:
targetAccount:
$ref: '#/components/schemas/Account'
description: The sparsely populated account this invitation is for.
name:
description: Required. The resource name for the invitation. `accounts/{account_id}/invitations/{invitation_id}`.
type: string
targetLocation:
$ref: '#/components/schemas/TargetLocation'
description: The target location this invitation is for.
targetType:
readOnly: true
enum:
- TARGET_TYPE_UNSPECIFIED
- ACCOUNTS_ONLY
- LOCATIONS_ONLY
type: string
description: Output only. Specifies which target types should appear in the response.
role:
enum:
- ADMIN_ROLE_UNSPECIFIED
- PRIMARY_OWNER
- OWNER
- MANAGER
- SITE_MANAGER
readOnly: true
type: string
description: Output only. The invited role on the account.
ListAccountAdminsResponse:
description: Response message for AccessControl.ListAccountAdmins.
properties:
accountAdmins:
description: A collection of Admin instances.
type: array
items:
$ref: '#/components/schemas/Admin'
type: object
ListAccountsResponse:
description: Response message for Accounts.ListAccounts.
type: object
properties:
accounts:
items:
$ref: '#/components/schemas/Account'
description: A collection of accounts to which the user has access. The personal account of the user doing the query
will always be the first item of the result, unless it is filtered out.
type: array
nextPageToken:
description: If the number of accounts exceeds the requested page size, this field is populated with a token to
fetch the next page of accounts on a subsequent call to `accounts.list`. If there are no more accounts, this field
is not present in the response.
type: string
ListInvitationsResponse:
description: Response message for AccessControl.ListInvitations.
type: object
properties:
invitations:
type: array
items:
$ref: '#/components/schemas/Invitation'
description: A collection of invitations that are pending for the account. The number of invitations listed here
cannot exceed 1000.
OrganizationInfo:
type: object
description: Additional information stored for an organization.
properties:
registeredDomain:
type: string
readOnly: true
description: Output only. The registered domain for the account.
phoneNumber:
type: string
description: Output only. The contact number for the organization.
readOnly: true
address:
$ref: '#/components/schemas/PostalAddress'
description: Output only. The postal address for the account.
PostalAddress:
description: 'Represents a postal address, such as for postal delivery or payments addresses. With a postal address,
a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical
locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing
existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready
address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements
for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema,
see: https://support.google.com/business/answer/6397478.'
type: object
properties:
locality:
type: string
description: 'Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune,
UK post town. In regions of the world where localities are not well defined or do not fit into this structure
well, leave `locality` empty and use `address_lines`.'
languageCode:
description: 'Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language
of the input form or is expected to match one of the languages used in the address'' country/region, or their
transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness
of the data and will never affect any validation or other non-formatting related operations. If this value is
not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja",
"ja-Latn", "en".'
type: string
regionCode:
type: string
description: 'Required. CLDR region code of the country/region of the address. This is never inferred and it is
up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
for details. Example: "CH" for Switzerland.'
sublocality:
type: string
description: Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
addressLines:
items:
type: string
type: array
description: Unstructured address lines describing the lower levels of an address. Because values in `address_lines`
do not have type information and may sometimes contain multiple values in a single field (for example, "Austin,
TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for
the country or region of the address. In places where this can vary (for example, Japan), `address_language` is
used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large).
In this way, the most specific line of an address can be selected based on the language. The minimum permitted
structural representation of an address consists of a `region_code` with all remaining information placed in the
`address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic
reasoning could be made about any of the address components until it was at least partially resolved. Creating
an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle
completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative
areas).
administrativeArea:
type: string
description: Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and
not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative
area in postal addresses. For example, in Switzerland, this should be left unpopulated.
recipients:
items:
type: string
type: array
description: Optional. The recipient at the address. This field may, under certain circumstances, contain multiline
information. For example, it might contain "care of" information.
organization:
description: Optional. The name of the organization at the address.
type: string
sortingCode:
description: Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is
used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or
just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office
indicator" (Côte d'Ivoire).
type: string
postalCode:
description: Optional. Postal code of the address. Not all countries use or require postal codes to be present,
but where they are used, they may trigger additional validation with other parts of the address (for example,
state or zip code validation in the United States).
type: string
revision:
format: int32
type: integer
description: The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All
new revisions **must** be backward compatible with old revisions.
TargetLocation:
type: object
properties:
address:
type: string
description: The address of the location to which the user is invited. Not always populated.
placeId:
description: Output only. The Place ID of the location to which the user is invited. Not always populated.
type: string
readOnly: true
locationName:
type: string
description: The name of the location to which the user is invited.
description: Represents a target location for a pending invitation.
x-provenance:
method: harvested
publisher: Google
source: https://mybusinessaccountmanagement.googleapis.com/$discovery/rest?version=v1
note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261110)