API reference

External IDs

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

GET/v1/external-id-keysThe kinds of external ID this workspace keeps, with how many people have each, plus presets not yet added

The kinds of external ID this workspace keeps, with how many people have each, plus presets not yet added

Example

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

Responses

200

POST/v1/external-id-keysKeep a new kind of ID: a preset (e.g. adp_associate_oid) or your own system and label

Keep a new kind of ID: a preset (e.g. adp_associate_oid) or your own system and label

Body (JSON)

Name	Type	Description
`preset`	string
`key`	string
`system`	string
`label`	string
`unique_values`	boolean

Example

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

Responses

200

PATCH/v1/external-id-keys/{id}Rename, reorder, or change whether values must be unique (the key itself never changes)

Rename, reorder, or change whether values must be unique (the key itself never changes)

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`system`	string
`label`	string
`unique_values`	boolean
`position`	integer

Example

curl -X PATCH "https://ca-api.clocklap.com/v1/external-id-keys/{id}" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"system":"string","label":"string","unique_values":true,"position":0}'

Responses

200

DELETE/v1/external-id-keys/{id}Stop keeping an ID type; removes everyone’s values for it

Stop keeping an ID type; removes everyone’s values for it

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

PUT/v1/users/{id}/external-idsSet, change or remove a person’s external IDs: { "adp_associate_oid": "G3MQ…", "deel_worker_id": null }

Set, change or remove a person’s external IDs: { "adp_associate_oid": "G3MQ…", "deel_worker_id": null }

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

GET/v1/users/lookupFind the person with an external ID, e.g. ?key=adp_associate_oid&value=G3MQ9V2WPTKKXSZ8

Find the person with an external ID, e.g. ?key=adp_associate_oid&value=G3MQ9V2WPTKKXSZ8

Query parameters

Name	Type	Description
`key`required	string
`value`required	string

Example

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

Responses

200