API reference

Directory

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

GET/v1/directory/resolveFind a workspace (and its region + branding) by work email or workspace slug

Find a workspace (and its region + branding) by work email or workspace slug

Query parameters

Name	Type	Description
`email`	string (email)
`workspace`	string

Example

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

Responses

200

POST/v1/leadsDemo request from the marketing website

Demo request from the marketing website

Body (JSON)

Name	Type	Description
`name`required	string
`email`required	string (email)
`company`required	string
`workers`	string
`region`	"ca" \| "us" \| "other"
`message`	string
`source`	string
`website`	string
`turnstile_token`	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/leads" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","email":"[email protected]","company":"string"}'

Responses

200

GET/v1/metaCatalogues: event types, permissions, built-in roles, regions, fonts

Catalogues: event types, permissions, built-in roles, regions, fonts

Example

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

Responses

200

POST/v1/signupStart a 30-day free trial: creates the workspace and signs the owner in

Start a 30-day free trial: creates the workspace and signs the owner in

Body (JSON)

Name	Type	Description
`company`required	string
`name`	string
`email`	string (email)
`password`	string
`assertion`	string
`region`required	"ca" \| "us"
`timezone`	string
`team_size`	string
`website`	string
`turnstile_token`	string
`analytics`	object	Google Analytics IDs from the clocklap.com cookies, so the sign-up counts toward the visit that led to it
`analytics.client_id`required	string
`analytics.session_id`	string
`code_verifier`	string	PKCE verifier, when the social sign-up was started with a code_challenge

Example

curl -X POST "https://ca-api.clocklap.com/v1/signup" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company":"string","region":"ca"}'

Responses

200

POST/v1/signup/resendEmail a new sign-up code

Email a new sign-up code

Body (JSON)

Name	Type	Description
`signup_id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/signup/resend" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"signup_id":"sig_01J…"}'

Responses

200

POST/v1/signup/startEmail sign-up, step 1: check the details and email a six-digit code (nothing is created yet)

Email sign-up, step 1: check the details and email a six-digit code (nothing is created yet)

Body (JSON)

Name	Type	Description
`company`required	string
`name`	string
`email`	string (email)
`password`	string
`assertion`	string
`region`required	"ca" \| "us"
`timezone`	string
`team_size`	string
`website`	string
`turnstile_token`	string
`analytics`	object	Google Analytics IDs from the clocklap.com cookies, so the sign-up counts toward the visit that led to it
`analytics.client_id`required	string
`analytics.session_id`	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/signup/start" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"company":"string","region":"ca"}'

Responses

200

POST/v1/signup/verifyEmail sign-up, step 2: confirm the code; creates the workspace and signs the owner in

Email sign-up, step 2: confirm the code; creates the workspace and signs the owner in

Body (JSON)

Name	Type	Description
`signup_id`required	string
`code`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/signup/verify" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"signup_id":"sig_01J…","code":"string"}'

Responses

200