Records

Describe a record type for writing

GET
/records/types/{record_type_id}/describe

Describe a record type for writing: field keys, types, required and unique rules, select option keys, relation targets and an example create payload. Call this before records.rows.create. An unpublished type is described from its draft with published false.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a scoped API key in the Adlass settings.

In: header

Path Parameters

record_type_id*string

Resource identifier: record_type_id.

Formatuuid

Header Parameters

X-Request-Id?string

Optional correlation identifier.

Lengthlength <= 128

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/records/types/123e4567-e89b-42d3-a456-426614174000/describe"
{}