View entity record

Production

https://{{subdomain}}.daftra.com/v2/api/entity

GET

/v2/api/entity/{entityKey}/{id}/{dataLevel}

Fetch a single record of any entity, addressed by its entityKey and primary key id.

This is a generic, metadata-driven endpoint: the returned record's columns are defined per entity, so the field set differs by entityKey. The record's own columns appear at the top level and related data is nested under the relation name.

When the entity has custom fields, the matching custom-fields row is included under custom_data.

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

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success. The single record: the entity's own columns at the top level, related data nested under relation names, and an optional custom_data object. The exact field set depends on the entity.

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/v2/api/entity/v2/api/entity/client/12/2' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "id": 12,
    "custom_data": {}
}

List entity records

Create entity record