API reference

Connections

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

GET/v1/connectionsList connections

List connections

Query parameters

Name	Type	Description
`kind`	"payroll" \| "hris" \| "accounting" \| "field_service"
`purpose`	"payroll" \| "hris" \| "accounting" \| "field_service"
`include_disconnected`	boolean

Example

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

Responses

200

POST/v1/connectionsAdd a connection. It starts in setup (setup_step 1); POST …/finish makes it live. purpose is required for systems that do payroll and HR

Add a connection. It starts in setup (setup_step 1); POST …/finish makes it live. purpose is required for systems that do payroll and HR

Body (JSON)

Name	Type	Description
`provider`required	string
`name`	string
`mode`	"direct" \| "file"
`purpose`	"payroll" \| "hris" \| "accounting" \| "field_service"
`location_ids`	array of string
`settings`	object
`settings.mode`	"direct" \| "file"
`settings.pay_codes`	object	Default {}
`settings.granularity`	"period_totals" \| "daily" \| "per_entry"
`settings.include`	"approved" \| "approved_submitted"	Default "approved"
`settings.skip_empty`	boolean	Default true
`settings.rounding`	"0.01" \| "0.25"	Default "0.01"
`settings.split_by`	"none" \| "location" \| "project" \| "department"	Default "none"
`settings.split_map`	object	Default {}
`settings.holiday_worked`	"separate" \| "regular"	Default "separate"
`settings.send_when`	object	Default {"mode":"manual","days_after":1,"time":"09:00"}
`settings.require_review`	boolean	Default true
`settings.people`	object	Default {"match":["email","employee_no","external_id"],"unmatched":"skip_and_warn"}
`settings.delivery`	object	Default {"method":"download","recipients":[]}
`settings.file`	object
`settings.provider`	object	Default {}
`settings.accounting`	object
`settings.field_service`	object

Example

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

Responses

200

GET/v1/connections/{id}Get one connection

Get one connection

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

PATCH/v1/connections/{id}Update one connection

Update one connection

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`name`	string
`status`	"active" \| "paused"
`location_ids`	array of string
`settings`	object
`setup_step`	integer

Example

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

Responses

200

DELETE/v1/connections/{id}Disconnect: revokes the sign-in where possible and deletes credentials; history stays

Disconnect: revokes the sign-in where possible and deletes credentials; history stays

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

GET/v1/connections/{id}/accounting/mappingProducts / income accounts per line kind, tax codes and the payments account, with the system’s own lists

Products / income accounts per line kind, tax codes and the payments account, with the system’s own lists

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

PUT/v1/connections/{id}/accounting/mappingSet mapping

Set mapping

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

GET/v1/connections/{id}/accounting/previewInvoices the next sync would send (new, changed, voided, or with new payments)

Invoices the next sync would send (new, changed, voided, or with new payments)

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

POST/v1/connections/{id}/accounting/syncSync now: send pending invoices and payments (or just the ones given). Returns the run

Sync now: send pending invoices and payments (or just the ones given). Returns the run

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`invoice_ids`	array of string

Example

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

Responses

200

GET/v1/connections/{id}/certificateOwn API project (ADP API Central): the certificate in use and the request (CSR) waiting to be signed. Never the private key

Own API project (ADP API Central): the certificate in use and the request (CSR) waiting to be signed. Never the private key

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

POST/v1/connections/{id}/certificate/requestMake the private key (kept encrypted, never shown) and the CSR to upload to the provider. With a certificate in use this starts a renewal; the current one keeps working until the new one is saved

Make the private key (kept encrypted, never shown) and the CSR to upload to the provider. With a certificate in use this starts a renewal; the current one keeps working until the new one is saved

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`organization`	string
`common_name`	string
`regenerate`	boolean

Example

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

Responses

200

POST/v1/connections/{id}/certificate/reuseUse the client ID, secret and certificate of this workspace’s other connection to the same system (e.g. ADP payroll and HR on one API Central project)

Use the client ID, secret and certificate of this workspace’s other connection to the same system (e.g. ADP payroll and HR on one API Central project)

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`from`required	string

Example

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

Responses

200

POST/v1/connections/{id}/credentialsSave keys (checked with the provider first) and SFTP secrets

Save keys (checked with the provider first) and SFTP secrets

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`fields`required	object

Example

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

Responses

200

GET/v1/connections/{id}/customersAccounting: your clients and the customer each is matched to in the system, with suggestions

Accounting: your clients and the customer each is matched to in the system, with suggestions

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

POST/v1/connections/{id}/customers/auto-matchMatch clients by email, then name (one clear customer each)

Match clients by email, then name (one clear customer each)

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/customers/auto-match" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/customers/matchMatch a client to a customer (remote_id), forget the match (null), leave it out ("ignore") or add it to the system now ("create")

Match a client to a customer (remote_id), forget the match (null), leave it out ("ignore") or add it to the system now ("create")

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`customer_id`required	string
`remote_id`	string or null

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/customers/match" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":"cus_01J…","remote_id":"rem_01J…"}'

Responses

200

POST/v1/connections/{id}/delivery/testTest SFTP / email delivery (pins the SFTP server key on first connect)

Test SFTP / email delivery (pins the SFTP server key on first connect)

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/delivery/test" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/finishFinish setup: the connection goes live (scheduled sends and syncs start). Direct connections must be signed in

Finish setup: the connection goes live (scheduled sends and syncs start). Direct connections must be signed in

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

POST/v1/connections/{id}/job-hoursSend hours on imported jobs back (notes or timecards), or build the hours CSV; preview: true lists what would go. Default window: the last 14 days

Send hours on imported jobs back (notes or timecards), or build the hours CSV; preview: true lists what would go. Default window: the last 14 days

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`preview`	boolean	Default false
`from`	string
`to`	string

Example

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

Responses

200

GET/v1/connections/{id}/jobsField service: jobs brought in, with the project, client and site each became

Field service: jobs brought in, with the project, client and site each became

Path parameters

Name	Type	Description
`id`required	string

Query parameters

Name	Type	Description
`search`	string
`limit`	integer

Example

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

Responses

200

POST/v1/connections/{id}/jobs/importBring jobs in now, or preview what would change (preview: true). File systems (ServiceTitan) send the CSV text

Bring jobs in now, or preview what would change (preview: true). File systems (ServiceTitan) send the CSV text

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`preview`	boolean	Default false
`csv`	string

Example

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

Responses

200

POST/v1/connections/{id}/oauth/startURL of the provider’s sign-in page (open it in the browser)

URL of the provider’s sign-in page (open it in the browser)

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/oauth/start" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/pay-codesPay types in use, the current mapping, suggestions and the provider’s own codes

Pay types in use, the current mapping, suggestions and the provider’s own codes

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

PUT/v1/connections/{id}/pay-codesSet pay codes

Set pay codes

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`pay_codes`required	object

Example

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

Responses

200

GET/v1/connections/{id}/peopleMatches, unmatched people on both sides, suggestions

Matches, unmatched people on both sides, suggestions

Path parameters

Name	Type	Description
`id`required	string

Query parameters

Name	Type	Description
`refresh`	boolean

Example

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

Responses

200

GET/v1/connections/{id}/people-syncPeople sync: settings, field ownership, location and team maps, last run

People sync: settings, field ownership, location and team maps, last run

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

PATCH/v1/connections/{id}/people-syncChange people sync settings (maps are replaced as a whole)

Change people sync settings (maps are replaced as a whole)

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`ownership`	object
`create_people`	boolean
`invite_new_people`	boolean
`new_people_role`	string
`on_termination`	"suggest" \| "deactivate"
`location_map`	object
`department_location_map`	object
`team_map`	object
`schedule`	"manual" \| "hourly" \| "daily"
`auto_apply`	boolean
`import_balances`	boolean
`leave_type_map`	object
`hours_per_day`	number
`push_time_off`	boolean
`file`	object
`file.source`	"upload" \| "sftp"
`file.columns`	object
`file.date_format`	"auto" \| "YYYY-MM-DD" \| "MM/DD/YYYY" \| "DD/MM/YYYY" \| "DD.MM.YYYY"
`file.sftp`	object or null

Example

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

Responses

200

POST/v1/connections/{id}/people-sync/balancesBring time off balances in from the HR system (dry_run: only show the differences)

Bring time off balances in from the HR system (dry_run: only show the differences)

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`dry_run`	boolean	Default false

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/balances" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dry_run":false}'

Responses

200

POST/v1/connections/{id}/people-sync/inspect-fileRead a worker file’s columns and first rows, to match its columns before a sync

Read a worker file’s columns and first rows, to match its columns before a sync

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/inspect-file" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/people-sync/leave-typesThe HR system’s leave types, the current mapping and suggestions

The HR system’s leave types, the current mapping and suggestions

Path parameters

Name	Type	Description
`id`required	string

Example

curl "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/leave-types" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people-sync/previewRead the HR system and list what would change (nothing changes yet). File systems: send the worker file (multipart, text/csv, an .xlsx, or JSON {csv}).

Read the HR system and list what would change (nothing changes yet). File systems: send the worker file (multipart, text/csv, an .xlsx, or JSON {csv}).

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/preview" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/people-sync/runsPeople syncs, balance imports and time off sends, newest first

People syncs, balance imports and time off sends, newest first

Path parameters

Name	Type	Description
`id`required	string

Query parameters

Name	Type	Description
`limit`	integer	Default 30

Example

curl "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/runs" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/people-sync/runs/{run}One sync with its changes

One sync with its changes

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Query parameters

Name	Type	Description
`action`	"create" \| "update" \| "deactivate" \| "reactivate" \| "skip"
`status`	"pending" \| "applied" \| "skipped" \| "failed" \| "dismissed"

Example

curl "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/runs/{run}" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people-sync/runs/{run}/applyApply a preview: every change that applies on its own, or only the ones listed; suggestions (turning people off or back on) only when asked

Apply a preview: every change that applies on its own, or only the ones listed; suggestions (turning people off or back on) only when asked

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Body (JSON)

Name	Type	Description
`only`	array of integer
`include_suggestions`	boolean

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/runs/{run}/apply" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"only":[0],"include_suggestions":true}'

Responses

200

POST/v1/connections/{id}/people-sync/runs/{run}/changes/{idx}/dismissLeave a person as they are (a suggestion isn’t offered again)

Leave a person as they are (a suggestion isn’t offered again)

Path parameters

Name	Type	Description
`id`required	string
`run`required	string
`idx`required	integer

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/runs/{run}/changes/{idx}/dismiss" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people-sync/sftp/testCheck the SFTP pickup: connect (pins the server key the first time), find the newest file matching the pattern and read it. Nothing is synced or stored.

Check the SFTP pickup: connect (pins the server key the first time), find the newest file matching the pattern and read it. Nothing is synced or stored.

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/sftp/test" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/people-sync/suggestionsPeople who left (or came back) in the HR system, waiting for a decision

People who left (or came back) in the HR system, waiting for a decision

Path parameters

Name	Type	Description
`id`required	string

Example

curl "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/suggestions" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/people-sync/time-offApproved time off sent to the HR system, newest first

Approved time off sent to the HR system, newest first

Path parameters

Name	Type	Description
`id`required	string

Example

curl "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/time-off" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people-sync/time-off/retryTry failed time off sends again now

Try failed time off sends again now

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/time-off/retry" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people-sync/uploadUpload a worker file and preview it (CSV in UTF-8, UTF-16 or Windows-1252, comma/semicolon/tab separated, or an Excel .xlsx; up to 10 MB). Multipart (field "file") or the raw file as the body. The file is read in memory and not kept; the preview run records what was read. Apply it with …/runs/:run/apply.

Upload a worker file and preview it (CSV in UTF-8, UTF-16 or Windows-1252, comma/semicolon/tab separated, or an Excel .xlsx; up to 10 MB). Multipart (field "file") or the raw file as the body. The file is read in memory and not kept; the preview run records what was read. Apply it with …/runs/:run/apply.

Path parameters

Name	Type	Description
`id`required	string

Query parameters

Name	Type	Description
`filename`	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people-sync/upload" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people/auto-matchMatch by email, employee number and stored IDs (one clear candidate each)

Match by email, employee number and stored IDs (one clear candidate each)

Path parameters

Name	Type	Description
`id`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people/auto-match" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/people/matchMatch one person (remote_id), forget a match (null) or leave them out ("ignore")

Match one person (remote_id), forget a match (null) or leave them out ("ignore")

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`user_id`required	string
`remote_id`	string or null

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/people/match" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"use_01J…","remote_id":"rem_01J…"}'

Responses

200

GET/v1/connections/{id}/runsList runs

List runs

Path parameters

Name	Type	Description
`id`required	string

Query parameters

Name	Type	Description
`kind`	string
`status`	string
`limit`	integer	Default 25
`cursor`	string

Example

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

Responses

200

POST/v1/connections/{id}/runsPreview (default) or send hours for a period

Preview (default) or send hours for a period

Path parameters

Name	Type	Description
`id`required	string

Body (JSON)

Name	Type	Description
`kind`	"push_hours" \| "push_time_off" \| "pull_people" \| "pull_balances"	Default "push_hours"
`period`	string	Any date in the pay period (YYYY-MM-DD). Default: the last closed period.
`from`	string
`to`	string
`preview`	boolean	true (default): compute lines and show them; nothing is sent Default true

Example

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

Responses

200

GET/v1/connections/{id}/runs/{run}One run: lines, warnings, per-line errors and (for admins) the redacted provider log

One run: lines, warnings, per-line errors and (for admins) the redacted provider log

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Example

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

Responses

200

POST/v1/connections/{id}/runs/{run}/discardThrow away a preview

Throw away a preview

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/runs/{run}/discard" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

GET/v1/connections/{id}/runs/{run}/fileDownload the run’s file

Download the run’s file

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Example

curl "https://ca-api.clocklap.com/v1/connections/{id}/runs/{run}/file" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/runs/{run}/retrySend the failed lines again

Send the failed lines again

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/runs/{run}/retry" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/runs/{run}/sendSend a preview (refused with preview_outdated if hours changed since)

Send a preview (refused with preview_outdated if hours changed since)

Path parameters

Name	Type	Description
`id`required	string
`run`required	string

Example

curl -X POST "https://ca-api.clocklap.com/v1/connections/{id}/runs/{run}/send" \
  -H "Authorization: Bearer $CLOCKLAP_API_KEY"

Responses

200

POST/v1/connections/{id}/testCheck sign-in, read one page of people and pay codes, check file delivery

Check sign-in, read one page of people and pay codes, check file delivery

Path parameters

Name	Type	Description
`id`required	string

Example

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

Responses

200

GET/v1/connections/catalogSystems ClockLap connects to, with whether each can connect directly here

Systems ClockLap connects to, with whether each can connect directly here

Example

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

Responses

200