API reference

API keys

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

GET/v1/api-keysList api keys

List api keys

Example

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

Responses

200

POST/v1/api-keysCreate a key. The full key is shown once.

Create a key. The full key is shown once.

Body (JSON)

Name	Type	Description
`name`required	string
`scopes`required	array of string (11 values)
`expires_in_days`	integer or null
`mode`	"live" \| "test"	Default "live"

Example

curl -X POST "https://ca-api.clocklap.com/v1/api-keys" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","scopes":["time:read"],"expires_in_days":1,"mode":"live"}'

Responses

200

DELETE/v1/api-keys/{id}Delete one api key

Delete one api key

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

GET/v1/sandboxThe test-data workspace that test keys (tt_test_…) work in

The test-data workspace that test keys (tt_test_…) work in

Example

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

Responses

200

POST/v1/sandbox/resetReplace the test data with fresh sample data (keys and webhooks stay)

Replace the test data with fresh sample data (keys and webhooks stay)

Example

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

Responses

200