Synup
Create a key
v1Resources/Clients/getList / search clients

List / search clients

Returns a page of your agency's clients, most recently created first. All filters are optional and combine together (a client must match all of them); to page through more results, pass the returned nextCursor back in.

get/api/v1/clients
clients:read
Query parameters
searchstringoptional
Free-text search over the client's business name, industry, or primary contact email (case-insensitive, partial matches allowed).
statusarray of string (complete | draft)optional
Restrict to one or more statuses: complete (active, fully onboarded) or draft (still being set up).
representativeIdsarray of stringoptional
Restrict to clients assigned to one or more of these team-member ids — see GET /api/v1/team/members for your agency's member ids.
goalsarray of string (improve_rankings | get_reviews | fix_listings)optional
Restrict to one or more of the client's primary goals: improve_rankings, get_reviews, or fix_listings.
healthMinnumberoptional
Lowest health score to include, 0–100.
healthMaxnumberoptional
Highest health score to include, 0–100.
locationsMinnumberoptional
Fewest locations a client must have to be included.
locationsMaxnumberoptional
Most locations a client can have and still be included.
createdAfterstringoptional
Only clients created on or after this date.
createdBeforestringoptional
Only clients created on or before this date.
cursorstringoptional
Pagination cursor from a previous response's nextCursor. Leave empty for the first page.
limitintegeroptional
Clients to return per page, 1–200. Defaults to 50.
Response
dataobjectoptional
clientsarray of objectoptional
The matching clients for this page.
idstringoptional
Unique identifier for the client.
businessNamestringoptional
The client's business name.
industrystringoptional
The client's industry.
statusstring (complete | draft)optional
Onboarding status: complete (active) or draft.
goalstring (improve_rankings | get_reviews | fix_listings)optional
The client's primary goal, or null.
healthScorenumberoptional
A 0–100 score summarizing the client's account health, or null if not yet computed.
locationCountnumberoptional
Number of locations this client has, or null if unknown.
googleRatingnumberoptional
The client's current Google star rating, or null.
googleReviewCountnumberoptional
The client's current Google review count, or null.
planNamestringoptional
Name of the plan this client is on, if any.
createdAtstringoptional
When the client was created, as an ISO 8601 timestamp.
archivedbooleanoptional
Whether the client is archived.
archivedAtstringoptional
When the client was archived, as an ISO 8601 timestamp, or null.
scheduledArchiveAtstringoptional
When archival was requested (also the cohort token for cancelling it), as an ISO 8601 timestamp, or null if none is pending.
primaryRepresentativeobjectoptional
The team member responsible for this client, or null.
idstringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
nextCursorstringoptional
Pagination cursor for the next page, or null when there are no more results.
totalnumberoptional
Total number of clients matching the filters, across all pages.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/clients
Your API key
search
status
representativeIds
goals
healthMin
healthMax
locationsMin
locationsMax
createdAfter
createdBefore
cursor
limit
{
  "data": {
    "clients": [
      {
        "id": "cli_123",
        "businessName": "Acme Dental",
        "industry": "Dental",
        "status": "complete",
        "goal": "get_reviews",
        "healthScore": 82,
        "locationCount": 1,
        "googleRating": 4.8,
        "googleReviewCount": 26,
        "archived": false,
        "archivedAt": null,
        "scheduledArchiveAt": null,
        "packageType": null,
        "planName": null,
        "createdAt": "2026-01-15T10:00:00.000Z",
        "primaryRepresentative": {
          "id": "usr_123",
          "firstName": "Jamie",
          "lastName": "Lee",
          "email": "jamie@youragency.com"
        }
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}