Objects & records

List, create, update and delete records in any object — one at a time or in bulk — and read the objects themselves.

GET/objects/{objectId}/recordsList records in an object
POST/objects/{objectId}/recordsCreate a record in an object
GET/objects/records/{id}Get a single record by id
PATCH/objects/records/{id}Update a record
DELETE/objects/records/{id}Delete a record
POST/objects/{objectId}/records/bulkBulk-create records in an object
GET/objectsList object schemas
POST/objectsCreate an object (schema)
GET/objects/{id}Get an object schema
PATCH/objects/{id}Update an object (schema / fields)
DELETE/objects/{id}Delete an object

List records in an object

GET/objects/{objectId}/records

Scope objects:viewRead-only

Path parameters

Name	Type
`objectId`required	string

Query parameters

Name	Type
`limit`	number
`cursor`	string
`sort`	string
`dir`	"asc" \| "desc"
`filter`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/objects/{objectId}/records?limit=25" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a record in an object

POST/objects/{objectId}/records

Scope objects:useWrites data

Path parameters

Name	Type
`objectId`required	string

Request body

Field	Type
`data`required	object
`owner`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/objects/{objectId}/records" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"data":{"policy_number":"STAR/2025/102309","premium":12600}}'

Get a single record by id

GET/objects/records/{id}

Scope objects:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/objects/records/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a record

PATCH/objects/records/{id}

Scope objects:useWrites data

Path parameters

Name	Type
`id`required	string

Request body

Field	Type
`data`required	object

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/objects/records/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"data":{}}'

Delete a record

DELETE/objects/records/{id}

Scope objects:useWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/objects/records/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Bulk-create records in an object

POST/objects/{objectId}/records/bulk

Scope objects:useWrites data

Path parameters

Name	Type
`objectId`required	string

Request body

Field	Type
`records`required	array of object

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/objects/{objectId}/records/bulk" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"records":[{}]}'

List object schemas

GET/objects

Scope objects:viewRead-only

Query parameters

Name	Type
`q`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/objects" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create an object (schema)

POST/objects

Scope objects:manageWrites data

Request body

Field	Type
`name`required	string
`pluralName`	string
`slug`	string
`description`	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X POST "https://api.klerc.co/api/v1/objects" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…","pluralName":"…","slug":"…","description":"…"}'

Get an object schema

GET/objects/{id}

Scope objects:viewRead-only

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X GET "https://api.klerc.co/api/v1/objects/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update an object (schema / fields)

PATCH/objects/{id}

Scope objects:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X PATCH "https://api.klerc.co/api/v1/objects/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Delete an object

DELETE/objects/{id}

Scope objects:manageWrites data

Path parameters

Name	Type
`id`required	string

Responses

200OK
201Created
401Authentication failed
403Insufficient scope / feature disabled
404Not found

curl

curl -X DELETE "https://api.klerc.co/api/v1/objects/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"