listingsAPIlistingsAPI
Get API keySign in
POST/api/v4/connected-accounts/connected-account-listings

Fetch listings of a connected account

Returns the Google Business Profile or Facebook listings accessible to a connected account, with optional filtering and pagination.

Requires an API key. See Authentication for header format and key rotation.

Parameters

Query

NameTypeRequiredDescriptionDefault
connectedAccountIdstringrequiredUUID of the connected account whose listings to fetch.—
filtersstringoptionalJSON-encoded object used to search within listings (for example by business name, address, phone, or postal code).—
pageInfostringoptionalJSON-encoded pagination object, e.g. `{"page":1,"perPage":20}`. Up to 500 records per page.—

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 — the connected account and paging/filter options are passed as query parameters, and no request body is required.

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 the JSON-encoded filters (it matches within name, address, phone, and postal code) so they can find the right storefront quickly.

Use case — feed connect-listing. The id on each record is exactly the listingId the connect-listing endpoint expects. Fetch the listings, let the customer (or your matching logic) choose one, then pass its id plus the target listingsAPI locationId to connect-listing to link them.

Paginate with the JSON-encoded pageInfo object ({"page":n,"perPage":m}); a page can return up to 500 records. Read pageInfo.hasNextPage and pageInfo.totalPages to walk the full set. This endpoint counts against the account rate limit — a 429 includes a Retry-After header.

The request shape and sample response above are documented from the API specification; the call is not executed against production data.

curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings?connectedAccountId=<connectedAccountId>' \
  -H "Authorization: API $LISTINGSAPI_KEY" \
  -H 'Content-Type: application/json'
Run in playground