/api/v4/connected-accounts/connected-account-listingsFetch listings of a connected account
Returns the Google Business Profile or Facebook listings accessible to a connected account, with optional filtering and pagination.
Parameters
Body
| Name | Type | Required | Description |
|---|---|---|---|
| connectedAccountId | string | required | UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored. |
| page | integer | optional | Page number to fetch. Defaults to 1. |
| perPage | integer | optional | Records per page. Defaults to 500, which is also the maximum. |
| locationInfo | string | optional | Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone. |
Sample request
Ready-to-paste body. Replace placeholder IDs and values with yours.
{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50}Responses
200List of listings accessible to the account, with pagination metadata.
{ "data": { "connectedAccountListings": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 60 }, "records": [ { "accountTypeName": "Google", "address": "123 William St, NY 10038, Manhattan, US", "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==", "liveLink": null, "locationName": "Trial", "phone": "(718) 667-7787" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Returns the Google Business Profile or Facebook listings that a connected account has access to. Each record includes the listing id (a base64 GraphQL ID), locationName, address, phone, and liveLink. Despite being a POST, this is a read operation, but the account and paging options must be sent in the JSON body.
Use case: build a listing picker. After a customer connects a Google account that owns dozens of listings, call this to render a searchable list. Put a customer-typed search term into locationInfo (it matches within name, address, phone, postal code, and store code) so they can find the right storefront quickly.
Use case: feed connect-listing. The id on each record is exactly the connectedAccountListingId that connect-listing expects. Fetch the listings, let the customer (or your matching logic) choose one, then pass its id plus the target Listings API locationId to connect-listing to link them.
Paginate with the flat page and perPage keys in the body; perPage defaults to 500, which is also the maximum. Read pageInfo.hasNextPage and pageInfo.totalPages from the response to walk the full set. This endpoint counts against the account rate limit, a 429 includes a Retry-After header.
The request shape above is verified against the live API. The sample response is illustrative.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50 }'