Listing Admins: List

Retrieve listing admins for entities in an account.

path Parameters
accountId
required
string
publisherId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

entityIds
string

A comma-separated list of Entity IDs. If no IDs are specified, defaults to all entities with a listings subscription.

pageToken
string

If a response to a previous request contained the nextPageToken field, pass that field's value as the pageToken parameter to retrieve the next page of data.

limit
integer
Default: 100

Number of results to return.

offset
integer
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    • "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
    },
  • "response": {
    • "count": 0,
    • "admins": [
      • {
        • "entityId": "string",
        • "publisherId": "string",
        • "adminName": "string",
        • "role": "ADMIN_ROLE_UNSPECIFIED",
        • "pendingInvitation": true
        }
      ],
    • "nextPageToken": "string"
    }
}

Listing Admin: Invite

Sends invitations to new listing admins for entities in an account. For Google Business Profile listings, the admins will be given owner-level access.

path Parameters
accountId
required
string
publisherId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
Array
entityId
string

ID of the entity that the admin will be associated with.

adminEmail
string

Email of the admin to be invited.

Responses

Request samples

Content type
application/json
[
  • {
    • "entityId": "string",
    • "adminEmail": "string"
    }
]

Response samples

Content type
application/json
{
  • "meta": {
    • "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
    },
  • "response": {
    • "count": 0,
    • "admins": [
      • {
        • "entityId": "string",
        • "publisherId": "string",
        • "adminName": "string",
        • "role": "ADMIN_ROLE_UNSPECIFIED",
        • "pendingInvitation": true
        }
      ]
    }
}