Notes

Freeform notes, attached to the records they're about.

GET/notesList notes
POST/notesCreate a note
GET/notes/{id}Get a note by id
PATCH/notes/{id}Update a note
DELETE/notes/{id}Delete a note

List notes

GET/notes

Scope notes:viewRead-only

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/notes?limit=25" \  -H "Authorization: Bearer $KLERC_TOKEN"

Create a note

POST/notes

Scope notes:useWrites data

Request body

Field	Type
`text`	string

Responses

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

curl

curl -X POST "https://api.klerc.co/api/v1/notes" \  -H "Authorization: Bearer $KLERC_TOKEN" \  -H "Content-Type: application/json" \  -d '{"text":"Prefers WhatsApp after 6pm."}'

Get a note by id

GET/notes/{id}

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

Update a note

PATCH/notes/{id}

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

Delete a note

DELETE/notes/{id}

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