API reference

Compliance

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

GET/v1/compliance/monitoring-policyElectronic monitoring policy: saved answers, live preview from current settings, and every published version

Electronic monitoring policy: saved answers, live preview from current settings, and every published version

Example

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

Responses

200

PUT/v1/compliance/monitoring-policy/draftSave the employer details and other monitoring the policy should describe

Save the employer details and other monitoring the policy should describe

Example

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

Responses

200

POST/v1/compliance/monitoring-policy/publishPublish the policy as a new version and notify everyone

Publish the policy as a new version and notify everyone

Body (JSON)

Name	Type	Description
`change_note`	string or null
`notify`	boolean

Example

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

Responses

200

GET/v1/monitoring-policyThe current published electronic monitoring policy (anyone in the workspace)

The current published electronic monitoring policy (anyone in the workspace)

Query parameters

Name	Type	Description
`version`	integer

Example

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

Responses

200

GET/v1/monitoring-policy/pdfThe published policy as a PDF

The published policy as a PDF

Query parameters

Name	Type	Description
`version`	integer

Example

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

Responses

200