My Business Account Management API
The My Business Account Management API provides an interface for managing access to a location on Google. Note: If you have a quota of 0 after enabling the…
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The My Business Account Management API provides an interface for managing access to a location on Google. Note: If you have a quota of 0 after enabling the API, please request GBP API access at https://developers.google.com/my-business/content/prereqs#request-access.
Endpoints 11
accounts
- GETLists all of the accounts for the authenticated user
/v1/accounts?filter=string&pageSize=0&pageToken=string&parentAccount=stringLists 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… - POSTCreates an account with the specified name and type under the given parent
/v1/accountsCreates an account with the specified name and type under the given parent. - Personal accounts and Organizations cannot be created. - User Groups cannot be… - GETGets the specified account
/v1/:nameGets the specified account. Returns NOT_FOUND if the account does not exist or if the caller does not have access rights to it.
locations.admins
- DELETERemoves the specified admin as a manager of the specified location.
/v1/:nameRemoves the specified admin as a manager of the specified location. - PATCHUpdates the Admin for the specified location
/v1/:name?updateMask=stringUpdates the Admin for the specified location. Only the AdminRole of the Admin can be updated. - GETLists all of the admins for the specified location.
/v1/:parent/adminsLists all of the admins for the specified location. - POSTInvites the specified user to become an administrator for the specified location
/v1/:parent/adminsInvites 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…
accounts.invitations
- POSTAccepts the specified invitation.
/v1/:name:acceptAccepts the specified invitation. - POSTDeclines the specified invitation.
/v1/:name:declineDeclines the specified invitation. - GETLists pending invitations for the specified account.
/v1/:parent/invitations?filter=stringLists pending invitations for the specified account.
locations
- POSTMoves a location from an account that the user owns to another account that the same user administers
/v1/:name:transferMoves 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…
API details
- Base URL
https://mybusinessaccountmanagement.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow)
An API key in the key query parameter - Operations
- 11 operations on 7 pathsPOST 5GET 4PATCH 1DELETE 1
- Main resources
- locations.admins 4accounts 3accounts.invitations 3locations 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the My Business Account Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the My Business Account Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists all of the accounts for the authenticated user” (GET /v1/accounts?filter=string&pageSize=0&pageToken=string&parentAccount=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the My Business Account Management API?
The My Business Account Management API provides an interface for managing access to a location on Google. Note: If you have a quota of 0 after enabling the… It is listed under Developer tools and has 11 endpoints.
Who publishes the My Business Account Management API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the My Business Account Management API?
Requests go to https://mybusinessaccountmanagement.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the My Business Account Management API?
It accepts 2 methods: OAuth 2.0 (authorization code flow); an API key in the key query parameter.
How many endpoints does the My Business Account Management API have?
11 operations on 7 paths (5 POST, 4 GET, 1 PATCH, 1 DELETE). The largest groups are locations.admins, accounts, accounts.invitations, locations.
Is forking the My Business Account Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.