Synupv1
Create a key
v1Resources/Locations/getGet locations summary

Get locations summary

Returns aggregate location counts across your agency (or one client), broken down by status, package tier, and verification state.

get/api/v1/locations/summary
locations:read
Query parameters
clientIdstringoptional
Limit to one client's locations. Omitted, this summarizes every location your key can see. Look it up with GET /api/v1/clients.
tagsstringoptional
Limit to locations carrying any of these comma-separated internal tags.
Response
dataobjectoptional
totalnumberoptional
Total number of matching locations.
byStatusobjectoptional
Location counts grouped by status.
byVerificationobjectoptional
Location counts grouped by verification state.
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/locations/summary
Your API key
clientId
tags
{
  "data": {
    "total": 12,
    "byStatus": {
      "approved": 10,
      "pending_verification": 1,
      "archival_pending": 1
    },
    "byVerification": {
      "verified": 9,
      "pending": 1,
      "unknown": 2
    }
  }
}