listingsAPI

Parameters

Query

Name	Type	Required	Description	Default
accountId	string	optional	listingsAPI account ID to scope results to. Defaults to the account that owns the API key.	—
filters	string	optional	JSON-encoded object used to narrow the result set (for example by connection status or account type).	—
sort	string	optional	JSON-encoded object describing the sort order to apply to the records.	—
pageInfo	string	optional	JSON-encoded pagination object, e.g. `{"page":1,"perPage":20}`.	—

Responses

200List of connected accounts with pagination metadata.

{
  "data": {
    "connectedAccountsInfo": {
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": false,
        "totalPages": 1,
        "totalRecords": 1
      },
      "records": [
        {
          "accountId": "62670",
          "clientName": "owner@brightsmile-dental.com",
          "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5",
          "connectedAccountType": "GoogleAccount",
          "connectedLocationsCount": 0,
          "connectivityIssue": null,
          "email": "owner@brightsmile-dental.com",
          "lastFetchMatchesRequestedAt": "2026-07-06 21:43:07 UTC",
          "remarks": null,
          "requestMatches": false,
          "requestMatchesStatus": "MATCH_COMPLETED",
          "status": "CONNECTED"
        }
      ]
    }
  }
}

401Unauthenticated — missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

Returns every Google Business Profile and Facebook Pages account authorized to connect with your listingsAPI account. Each record carries the connection health (status, connectivityIssue), how many locations are linked (connectedLocationsCount), and the state of the last match fetch (requestMatchesStatus).

Use case — audit connection health before a sync. Run this at the top of a nightly job to find accounts whose credentials have lapsed. Any record with a non-null connectivityIssue or a status other than CONNECTED needs the customer to re-authorize through the connect flow; skip those so you do not waste a trigger-matches call on a dead credential.

Use case — resolve a connectedAccountId for downstream calls. The trigger-matches, fetch-listings, folders, and details endpoints all key off connectedAccountId. List the accounts, pick the one whose email matches the customer, and reuse its connectedAccountId.

Pagination and filtering are driven by JSON-encoded query parameters. pageInfo accepts an object such as {"page":1,"perPage":20}, while filters and sort take JSON-encoded objects for narrowing and ordering the record set. Read pageInfo.hasNextPage and pageInfo.totalPages in the response to decide whether to fetch another page. This endpoint counts against the account rate limit — a 429 includes a Retry-After header.