List records across all customers
GET/objects/:object_id/records
Every record of one object type, across every customer. This is how you ask "all deals that closed this month" without walking the customer list.
Filter on a field's value with field.<key>=<value>, for example
?field.stage=Won&field.owner=agent_12. Comparison is case-insensitive string
equality, so select lists and free-text fields behave the same way; use
created_after / created_before for date ranges.
This query is served by a Firestore collection-group index. If that index is
still building, the endpoint answers 503 with code: index_required rather
than returning a partial list — fall back to the per-customer endpoint in the
meantime.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 503
Records returned.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No such resource in this account.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
A dependency is temporarily unavailable, or a required index is still building. Safe to retry.
Response Headers
Correlation id for this request. Quote it when reporting a problem.