API reference

Activity

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

POST/v1/activity/noticeAcknowledge the desktop app’s notice that it records apps and window titles

Acknowledge the desktop app’s notice that it records apps and window titles

Example

curl -X POST "https://ca-api.clocklap.com/v1/activity/notice" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/activity/samplesUpload app/window samples recorded while a timer ran

Upload app/window samples recorded while a timer ran

Body (JSON)

Name	Type	Description
`samples`required	array of object
`samples[].started_at`required	string (date-time)
`samples[].seconds`required	integer
`samples[].app`required	string
`samples[].title`	string
`samples[].idle`	boolean
`device_id`	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/activity/samples" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"samples":[{"started_at":"2026-10-26T13:00:00Z","seconds":1,"app":"string"}],"device_id":"dev_01J…"}'

Responses

200

POST/v1/activity/screenshotsUpload a screenshot (multipart, field "file"), only where the workspace turned screenshots on

Upload a screenshot (multipart, field "file"), only where the workspace turned screenshots on

Query parameters

Name	Type	Description
`taken_at`required	string (date-time)

Example

curl -X POST "https://ca-api.clocklap.com/v1/activity/screenshots" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/activity/screenshots/{id}A screenshot (the person, or managers who can see the entry)

A screenshot (the person, or managers who can see the entry)

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

GET/v1/time-entries/{id}/activityApps, window titles and screenshots recorded during an entry

Apps, window titles and screenshots recorded during an entry

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

DELETE/v1/time-entries/{id}/activityDelete what was recorded during one of your entries (the entry stays)

Delete what was recorded during one of your entries (the entry stays)

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200