Skip to content
ClockLap Developers
API reference clocklap.com Get an API key

API reference

Policies

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

GET/v1/break-presetsMeal and rest break presets, with the rules in plain words. A starting point — check your obligations.

Meal and rest break presets, with the rules in plain words. A starting point — check your obligations.

Example

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

Responses

200

GET/v1/locations/{id}/policyEffective policy with the source of every value

Effective policy with the source of every value

Path parameters

NameTypeDescription
idrequiredstring

Example

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

Responses

200

PUT/v1/locations/{id}/policyReplace this location's override patch ({} = inherit everything)

Replace this location's override patch ({} = inherit everything)

Path parameters

NameTypeDescription
idrequiredstring

Example

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

Responses

200

GET/v1/policyWorkspace-level effective policy

Workspace-level effective policy

Example

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

Responses

200

PUT/v1/policyReplace the workspace policy patch

Replace the workspace policy patch

Example

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

Responses

200