List entity records - Daftra API

List records of any entity, addressed by its entityKey (e.g. client, product, cost_center, work_order).

This is a generic, metadata-driven endpoint: the columns of each returned record are defined per entity, so the field set differs by entityKey. Use the entity schema/fields endpoints to discover an entity's fields.

Authentication & authorization. Requires an OAuth2 Bearer token. The caller must hold the entity's view permission; otherwise the request is rejected with 401.

Response modes. The mode query parameter selects the response shape (default api, a paginated list):

Value	Meaning
api	Paginated list (default).
paginate	Paginated list.
listing	Lightweight id/label list, for dropdowns.
count	Returns only `{ "total": <n> }`.
export	Export-oriented payload.
nav	Navigation (prev/next) payload.

Filtering. Pass nested filters as filter[<field>][<operator>]=<value> (operators include equal, like); group alternatives under filter[or][<field>][<operator>]=<value>.

Field selection. Pass fields[]=<column> (repeatable) to limit the columns returned.

Responses

🟢200OK

application/json

Success. In the default api/paginate modes a paginated envelope is returned; count mode returns { "total": <n> }. Each record's own columns are at the top level and related data is nested under the relation name (fields are entity-specific).

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

curl --location --globoff 'https://.daftra.com/v2/api/entity/v2/api/entity/client/list/2?mode=api&fields[]=id&filter[%3Cfield%3E][%3Coperator%3E]=acme&per_page=20&page=1&sort=id&version=2' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer ' \ --header 'apikey: ' \ --header 'Content-Type: application/json'

{ "current_page": 1, "data": [ {} ], "from": 1, "to": 1, "per_page": 20, "last_page": 1, "total": 1, "path": "https://{subdomain}.daftra.com/v2/api/entity/client/list/2" }