Query records
POST/objects/:object_id/records/query
Records matching a filter tree, sorted and searched exactly like a console view —
the same operators the Filter panel offers, by field api_id.
A filter tree is {operator: AND|OR, conditions: [...]}; a condition is either
{field_id, op, value, value2} or a nested group (two levels, up to 25 conditions).
op depends on the field's type — text: contains, eq, starts_with, is_empty…;
number: eq, gt, lt, between…; date: on, before, after, in_last
(value + value2 ∈ days|weeks|months), this_month…; choice: eq, in, is_empty;
checkbox: is_true, is_false; linked record: eq, in, is_empty.
Use the object's definition to see each field's type. Cursor-paged like
List records.
Request
Responses
- 200
- 400
- 401
- 403
- 404
Matching records.
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.