API reference

Notes

6 endpoints. Click one to see its parameters, fields and an example. Code samples use the region you pick.

GET/v1/notesNotes on something, newest first

Notes on something, newest first

Query parameters

Name	Type	Description
`attached_type`	"project" \| "customer" \| "location" \| "time_entry" \| "invoice"
`attached_id`	string
`kind`	"text" \| "voice"
`status`	"pending" \| "transcribing" \| "summarising" \| "ready" \| "failed"
`mine`	"0" \| "1" \| "true" \| "false"
`limit`	integer
`before`	string (date-time)

Example

curl "https://ca-api.clocklap.com/v1/notes" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/notesAdd a typed note, or a voice note from an uploaded recording (transcribed and summarised in the background)

Add a typed note, or a voice note from an uploaded recording (transcribed and summarised in the background)

Body (JSON)

Name	Type	Description
`id`	string
`body`	string
`audio_media_id`	string
`media_ids`	array of string
`attach_to`required	array of object
`attach_to[].type`required	"project" \| "customer" \| "location" \| "time_entry" \| "invoice"
`attach_to[].id`required	string
`visibility`	"private" \| "project"

Example

curl -X POST "https://ca-api.clocklap.com/v1/notes" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"attach_to":[{"type":"project","id":"id_01J…"}]}'

Responses

200

GET/v1/notes/{id}Get one note

Get one note

Path parameters

Name	Type	Description
`id`required	string

Example

curl "https://ca-api.clocklap.com/v1/notes/{id}" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

PATCH/v1/notes/{id}Update one note

Update one note

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`body`	string
`title`	string
`summary`	string
`follow_ups`	array of string
`visibility`	"private" \| "project"
`media_ids`	array of string

Example

curl -X PATCH "https://ca-api.clocklap.com/v1/notes/{id}" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

200

DELETE/v1/notes/{id}Delete one note

Delete one note

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X DELETE "https://ca-api.clocklap.com/v1/notes/{id}" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/notes/{id}/retryTry transcribing a voice note again

Try transcribing a voice note again

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/notes/{id}/retry" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200