Lists

Saved segments — live queries or frozen snapshots — and the records in them.

GET/listsList saved lists (segments)
POST/listsCreate a list (segment)
GET/lists/{id}Get a list
PATCH/lists/{id}Update a list
DELETE/lists/{id}Delete a list
GET/lists/{id}/recordsGet the records in a list
POST/lists/{id}/freezeFreeze a list (snapshot its members)
POST/lists/{id}/refreshRefresh a dynamic list

List saved lists (segments)

GET/lists

Scope objects:viewRead-only

Responses

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

curl

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

Create a list (segment)

POST/lists

Scope objects:useWrites data

Request body

Field	Type
`name`required	string
`object`	string
`description`	string
`mode`	"dynamic" \| "static"
`queryText`	string

Responses

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

curl

curl -X POST "https://api.klerc.co/api/v1/lists" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"name":"…","object":"…","description":"…","mode":"dynamic","queryText":"…"}'

Get a list

GET/lists/{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/lists/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Update a list

PATCH/lists/{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 PATCH "https://api.klerc.co/api/v1/lists/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Delete a list

DELETE/lists/{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/lists/{id}" \  -H "Authorization: Bearer $KLERC_TOKEN"

Get the records in a list

GET/lists/{id}/records

Scope objects:viewRead-only

Path parameters

Name	Type
`id`required	string

Query parameters

Name	Type
`limit`	number
`cursor`	string

Responses

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

curl

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

Freeze a list (snapshot its members)

POST/lists/{id}/freeze

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 POST "https://api.klerc.co/api/v1/lists/{id}/freeze" \  -H "Authorization: Bearer $KLERC_TOKEN"

Refresh a dynamic list

POST/lists/{id}/refresh

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 POST "https://api.klerc.co/api/v1/lists/{id}/refresh" \  -H "Authorization: Bearer $KLERC_TOKEN"