Reference

Pagination and filtering

How listing works per endpoint group, and how to filter and sort data objects.
View as Markdown

Pagination is not uniform across the API. Each group paginates the way that fits its data. Data objects have the richest filtering and sorting. This page covers both.

Pagination by group

?limit (default 50, max 200). No cursor. You get a single most-recent page.

$curl "https://api.cloudraker.com/spaces/{spaceId}/files?limit=50" \
>  -H "Authorization: Bearer $RAKERONE_API_KEY"

Filtering data objects

GET /spaces/{spaceId}/objects/{definitionId} accepts three query parameters that shape the result set:

  • filter — a JSON array of entries { fieldKey, subField?, operand, value }.
  • sort — a JSON array of { fieldKey, direction }. direction is "asc" or "desc". The default sort is createdAt descending.
  • view — a saved-view id. Its stored filters and sorts apply instead. It is mutually exclusive with filter/sort. Both together return 400 invalid_request. An unknown or wrong-scope view returns 404 view_not_found.

subField targets a nested field of a composite, for example a city inside an address.

An unknown or archived field in filter/sort returns 422. A $-injection attempt also returns 422.

Operands

There are 14 filter operands:

OperandMeaning
isEquals
is_notNot equal
is_emptyField has no value
is_not_emptyField has a value
containsSubstring match
does_not_containNegated substring match
gtGreater than
gteGreater than or equal
ltLess than
lteLess than or equal
is_beforeDate before
is_afterDate after
is_any_ofValue in a list
includesList field includes value(s)

Example

Filter to unpaid Acme invoices, newest first:

$curl -G "https://api.cloudraker.com/spaces/{spaceId}/objects/{definitionId}" \
>  -H "Authorization: Bearer $RAKERONE_API_KEY" \
>  --data-urlencode 'filter=[{"fieldKey":"vendor","operand":"is","value":"Acme"},{"fieldKey":"status","operand":"is_not","value":"paid"}]' \
>  --data-urlencode 'sort=[{"fieldKey":"invoiceDate","direction":"desc"}]'

Returned objects

Each object in the response carries its inline data and fieldMeta. When present, it also carries:

  • provenance / review — for AI-imported values (source citations and approval state).
  • origin — { actionRunId?, playbookRunId? } for values produced by an action or playbook run.

Where to go next

Errors

Status codes and error codes across the API.

API reference

Full request and response schemas for every list endpoint.