Query records

Returns a page of records that match your filters, in the order you choose. Pages hold 1 to 100 records (default 20). There are more pages while offset + returned < total. File fields come back as references; download a file with /api/v4/records/content.

Auth

X-API-Key

Counts as

1 request

Idempotency

not supported

Headers

X-API-Keystringrequired

Read from your server environment.

Content-Typestringrequired

application/json.

Body parameters

modulestringrequired

The module's table name, shown under the module name on its card in Beezr Designer (for example cm_equipment_requests_base).

fieldsarray of stringoptional

Return only these fields (id always comes back)

filtersobjectoptional

and: every condition must match. or: at least one must match (the OR group is ANDed with the rest). groups: nested groups, each ANDed with the rest.

filters.andarray of objectoptional

—

filters.and[].fieldstringrequired

A field's System name

filters.and[].operatorstringrequired

Values: eq, ne, gt, gte, lt, lte, in, not_in, contains, starts_with, ends_with, is_null, is_not_null.

filters.and[].valuevalueoptional

Not used by is_null / is_not_null. An array for in / not_in.

filters.orarray of objectoptional

—

filters.or[].fieldstringrequired

A field's System name

filters.or[].operatorstringrequired

Values: eq, ne, gt, gte, lt, lte, in, not_in, contains, starts_with, ends_with, is_null, is_not_null.

filters.or[].valuevalueoptional

Not used by is_null / is_not_null. An array for in / not_in.

filters.groupsarray of objectoptional

—

sortarray of objectoptional

—

sort[].fieldstringrequired

—

sort[].directionstringoptional

Default asc. Values: asc, desc.

limitintegeroptional

Values outside 1–100 are clamped Minimum 1. Maximum 100. Default 20.

offsetintegeroptional

Minimum 0. Default 0.

Returns

HTTP 200. A page of records.

successbooleanoptional

—

dataarray of objectoptional

—

data[].idintegeroptional

—

metaobjectoptional

—

meta.totalintegeroptional

Records that match

meta.limitintegeroptional

—

meta.offsetintegeroptional

—

meta.returnedintegeroptional

Records in this page

Field values come back in the same form the Designer shows them.

File fields contain references in v4. Read fileExtension as returned.

Errors