Listings Admin | Hitchhikers Platform

Overview

Some publishers allow multiple people to own or manage their listings. This can be very helpful if you want both corporate and franchisees to work together to contribute accurate data to their listings. The Listing Admins APIs allow you to manage who has access to each listing.

Because the Listing Admin APIs are currently only available for Google My Business, we’ll focus on Google. Google allows listings to have multiple owners. Owners are defined by their Gmail accounts and have access to update content on listings on behalf of the business.

To view the current list of Gmail accounts that have access to your listing, use the Listing Admins: List endpoint. To invite a new Gmail account to have access to your listing, use the Listing Admins: Invite endpoint.

Use Cases

Invite users to become an admin or manager of your listings.
See who has access to your listing as well as their level of access.

Reference Docs

Listing Admins Endpoints

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

200
default

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

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

Payload

Content type

application/json

[{"entityId": "string",
"adminEmail": "string"
}
]

Response samples

200
default

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
}
]
}
}