Connecteam

Remove a pay rule policy assignment, via DELETE /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments/{assignmentId}.

Remove a pay rule from a pay rule policy, via DELETE /company-policies/v1/pay-rule-policies/{payRulePolicyId}/pay-rules/{payRuleId}.

Delete a scheduling rule policy, via DELETE /company-policies/v1/scheduling-rule-policies/{schedulingRulePolicyId}.

Delete a user's custom working hours, via DELETE /company-policies/v1/users/{userId}/working-hours.

Unassign a user from a working hours policy, via DELETE /company-policies/v1/working-hours-policies/{workingHoursPolicyId}/assignments/{userId}.

Delete a daily note, via DELETE /daily-info/v1/daily-note/{noteId}.

Delete a dropdown option, via DELETE /forms/v1/forms/{formId}/questions/{questionId}/options/{optionId}.

Delete a job, via DELETE /jobs/v1/jobs/{jobId}.

Delete a user's pay rate for one effective date, via DELETE /pay-rates/v1/pay-rates/users/{userId}/{effectiveDate}. Removes ONE dated pay rate, addressed by user and effective date. The user's other dated rates survive, so deleting the current one makes the previous dated rate take effect rather than leaving them unpaid.

Delete every sales transaction in a period, via DELETE /sales/v1/transactions. DELETES BY PERIOD, NOT BY ID, and it takes no body: `locationId`, `startTime` and `endTime` are REQUIRED query parameters and everything inside that window at that location goes. A wrong `endTime` is not a failed call, it is a wider delete that succeeds. Use 'Delete one sales transaction' when you know the id.

Delete one sales transaction, via DELETE /sales/v1/transactions/{transactionId}.

Delete shifts by id, in bulk (scheduler v1), via DELETE /scheduler/v1/schedulers/{schedulerId}/shifts. BULK: the scheduler is named in the path and the shifts to remove in the body, as `shiftsIds` -- up to 20 per call. `notifyUsers` decides whether the assigned employees are told, which is a real-world effect rather than a formatting choice.

Delete one shift (scheduler v1), via DELETE /scheduler/v1/schedulers/{schedulerId}/shifts/{shiftId}.

Delete a scheduler unavailability, via DELETE /scheduler/v1/schedulers/{schedulerId}/unavailability/{unavailabilityId}.

Delete shifts by id, in bulk (scheduler v2), via DELETE /scheduler/v2/schedulers/{schedulerId}/shifts. BULK: the scheduler is named in the path and the shifts to remove in the body, as `shiftsIds` -- up to 20 per call. `notifyUsers` decides whether the assigned employees are told. The v2 shape of the same operation; pick the version the rest of your scheduler calls use.

Delete one shift (scheduler v2), via DELETE /scheduler/v2/schedulers/{schedulerId}/shifts/{shiftId}.

Delete a webhook, via DELETE /settings/v1/webhooks/{webhookId}.

Delete a task, via DELETE /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}.

Delete a subtask, via DELETE /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks/{subTaskId}.

Delete a geofence, via DELETE /time-clock/v1/time-clocks/{timeClockId}/geofences/{fenceId}.

Delete a time activity, via DELETE /time-clock/v1/time-clocks/{timeClockId}/time-activities/{timeActivityId}.

Delete user custom fields, via DELETE /users/v1/custom-fields. BULK: `customFieldIds` in the body, up to 100 per call. Deleting a custom field removes the VALUE it holds on every user, not just the field definition.

Delete a user custom field option, via DELETE /users/v1/custom-fields/{customFieldId}/options/{optionId}.

Delete pending users, in bulk, via DELETE /users/v1/pending-users. BULK: `ids` in the body. A pending user is someone invited who has not yet joined; deleting one withdraws the invitation.

Delete a pending user, via DELETE /users/v1/pending-users/{pendingUserId}.

Delete a smart group, via DELETE /users/v1/smart-groups/{smartGroupId}.

Archive or delete users, in bulk, via DELETE /users/v1/users. BULK, AND IT IS BOTH ARCHIVE AND DELETE. The body is a plain JSON ARRAY of user ids, and `deletionType` decides which of the two happens -- an archive is reversible in the product, a delete is not. There is no per-user confirmation in between: every id in the array is acted on. Send the ids you mean and read `deletionType` before you do.

Delete one user, via DELETE /users/v1/users/{userId}. Deletes ONE user, addressed entirely by path, with no body and no `deletionType` -- so this is the delete, not the archive. Use 'Archive or delete users, in bulk' when you want the reversible option.

Get an asset's metadata, via GET /assets/v1/asset/{assetId}.

Get one file's download URL, via GET /attachments/v1/files/{fileId}. Returns a signed DOWNLOAD URL and the file's metadata, never the bytes. Fetch the URL yourself; it is time-limited.

List chat conversations, via GET /chat/v1/conversations.

List pay rule policies, via GET /company-policies/v1/pay-rule-policies.

List a pay rule policy's assignments, via GET /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments.

List pay rules, via GET /company-policies/v1/pay-rules.

List scheduling rule policies, via GET /company-policies/v1/scheduling-rule-policies.

List a scheduling rule policy's assignments, via GET /company-policies/v1/scheduling-rule-policies/{schedulingRulePolicyId}/assignments.

List a user's scheduling rule policies, via GET /company-policies/v1/users/{userId}/scheduling-rule-policies.

Get a user's working hours, via GET /company-policies/v1/users/{userId}/working-hours.

List working hours policies, via GET /company-policies/v1/working-hours-policies.

Get a daily note, via GET /daily-info/v1/daily-note/{noteId}.

List forms, via GET /forms/v1/forms.

Get a form, via GET /forms/v1/forms/{formId}.

List form submissions, via GET /forms/v1/forms/{formId}/form-submissions.

Get a form submission, via GET /forms/v1/forms/{formId}/form-submissions/{formSubmissionId}.

List a dropdown question's options, via GET /forms/v1/forms/{formId}/questions/{questionId}.

List job custom fields, via GET /jobs/v1/custom-fields.

List jobs, via GET /jobs/v1/jobs.

Get a job, via GET /jobs/v1/jobs/{jobId}.

Get the connected Connecteam account, via GET /me. The connection's health check and the smallest possible read: it returns the company's own id and name. It is the endpoint this provider's connect probe calls, and the one worth calling first when a tool fails, because its answer separates the two failures a Connecteam 401/403 can mean -- measured 2026-09-25, a WRONG key answers 403 {"detail":"Invalid API key"} while a MISSING header answers 401.

List onboarding packs, via GET /onboarding/v1/packs.

List an onboarding pack's assignments, via GET /onboarding/v1/packs/{packId}/assignments.

List pay rates, via GET /pay-rates/v1/pay-rates.

List publishers, via GET /publishers/v1/publishers.

List daily sales, via GET /sales/v1/daily-sales.

List sales locations, via GET /sales/v1/locations.

List schedulers, via GET /scheduler/v1/schedulers.

List a scheduler's shift custom fields, via GET /scheduler/v1/schedulers/{schedulerId}/custom-fields.

List a scheduler's shift layers, via GET /scheduler/v1/schedulers/{schedulerId}/shift-layers.

List a shift layer's values, via GET /scheduler/v1/schedulers/{schedulerId}/shift-layers/{layerId}/values.

List shifts (scheduler v1), via GET /scheduler/v1/schedulers/{schedulerId}/shifts. `startTime` and `endTime` are REQUIRED (Unix seconds): Connecteam will not return an unbounded shift history. The v1 shape -- see 'List shifts (scheduler v2)' for the newer one; both are live and they are not interchangeable, so read shifts back with the version you wrote them with.

Get a shift auto-assign request's status (scheduler v1), via GET /scheduler/v1/schedulers/{schedulerId}/shifts/auto-assign/{autoAssignRequestId}.

Get a shift (scheduler v1), via GET /scheduler/v1/schedulers/{schedulerId}/shifts/{shiftId}.

List a scheduler's unavailabilities, via GET /scheduler/v1/schedulers/{schedulerId}/unavailabilities.

List one user's unavailability (scheduler v1), via GET /scheduler/v1/schedulers/user-unavailability.

List shifts (scheduler v2), via GET /scheduler/v2/schedulers/{schedulerId}/shifts. `startTime` and `endTime` are REQUIRED (Unix seconds). The v2 shape of the same listing; both versions are live and carry the same eight operations, so pick one and stay on it within a workflow.

Get a shift auto-assign request's status (scheduler v2), via GET /scheduler/v2/schedulers/{schedulerId}/shifts/auto-assign/{autoAssignRequestId}.

Get a shift (scheduler v2), via GET /scheduler/v2/schedulers/{schedulerId}/shifts/{shiftId}.

List one user's unavailability (scheduler v2), via GET /scheduler/v2/schedulers/user-unavailability.

List webhooks by feature type, via GET /settings/v1/webhooks.

Get a webhook, via GET /settings/v1/webhooks/{webhookId}.

List task boards, via GET /tasks/v1/taskboards.

List task board labels, via GET /tasks/v1/taskboards/{taskBoardId}/labels.

List tasks, via GET /tasks/v1/taskboards/{taskBoardId}/tasks.

List a task's subtasks, via GET /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks.

Get a breadcrumbs report's status, via GET /time-clock/breadcrumbs/v1/report/{fileId}.

Get a breadcrumbs report's download link, via GET /time-clock/breadcrumbs/v1/report/{fileId}/download. Returns a signed download LINK for a finished breadcrumbs report, not the report itself. Breadcrumbs are employees' recorded GPS trails -- location data about identifiable people -- so treat the link as personal data and do not paste it anywhere it will outlive its expiry.

List time clocks, via GET /time-clock/v1/time-clocks.

List geofences, via GET /time-clock/v1/time-clocks/{timeClockId}/geofences.

Get a geofence, via GET /time-clock/v1/time-clocks/{timeClockId}/geofences/{fenceId}.

List manual break types, via GET /time-clock/v1/time-clocks/{timeClockId}/manual-breaks.

List time-clock shift attachments, via GET /time-clock/v1/time-clocks/{timeClockId}/shift-attachments.

List time activities, via GET /time-clock/v1/time-clocks/{timeClockId}/time-activities.

Get timesheet total hours, via GET /time-clock/v1/time-clocks/{timeClockId}/timesheet. Returns TOTALS for the window, not the individual time activities. Use 'List time activities' when you need the underlying punches.

List time-off policy types, via GET /time-off/v1/policy-types.

List time-off balances for a policy type, via GET /time-off/v1/policy-types/{policyTypeId}/balances.

List time-off requests, via GET /time-off/v1/requests.

List user custom field categories, via GET /users/v1/custom-field-categories.

List user custom fields, via GET /users/v1/custom-fields.

List a user custom field's options, via GET /users/v1/custom-fields/{customFieldId}/options.

List pending users, via GET /users/v1/pending-users.

List performance indicators, via GET /users/v1/performance-indicators.

List smart group segments, via GET /users/v1/smart-group-segments.

List smart groups, via GET /users/v1/smart-groups.

List users, via GET /users/v1/users. Paged: `limit` (default 10, maximum 500) and `offset`, where the response's `paging.offset` is what to pass next. `userStatus` defaults to `active`, so ARCHIVED USERS ARE ABSENT unless you ask for `archived` or `all` -- the most common reason a user 'is missing'.

List a user's assignments, via GET /users/v1/users/{userId}/assignments.

Get download URLs for several files, via POST /attachments/v1/files/download-url. The batch form of 'Get one file's download URL' -- several file ids in, several signed URLs out. A POST because the id list is a body, not because it changes anything; it is catalogued as a write for that reason and `attachments.read` is the permission it needs.

Start a file upload (get a signed upload URL), via POST /attachments/v1/files/generate-upload-url. STEP 1 OF 3, and Agentic Fabriq carries no bytes in either direction. This returns a SIGNED URL your own client PUTs the file to; then call 'Finish a file upload' with the file id to register it with Connecteam. Nothing here accepts or returns file content -- a tool argument and a tool result are JSON in a model's context window.

Create a chat conversation, via POST /chat/v1/conversations.

Send a message to a chat conversation, via POST /chat/v1/conversations/{conversationId}/message. SENDS A REAL MESSAGE to real employees, immediately and irreversibly: there is no unsend on this API. Not marked destructive -- nothing is deleted -- but it is the tool on this surface most likely to have an effect a customer cannot take back.

Send a private chat message to a user, via POST /chat/v1/conversations/privateMessage/{userId}. Sends a one-to-one message to that user, immediately and irreversibly. If no private conversation exists yet Connecteam opens one, so this also creates a conversation as a side effect.

Create daily notes, via POST /daily-info/v1/daily-notes.

Add options to a dropdown question, via POST /forms/v1/forms/{formId}/questions/{questionId}.

Create jobs, via POST /jobs/v1/jobs.

Assign users to an onboarding pack, via POST /onboarding/v1/packs/{packId}/assignments.

Create a sales location, via POST /sales/v1/locations.

Create sales transactions, via POST /sales/v1/transactions.

Create shifts (scheduler v1), via POST /scheduler/v1/schedulers/{schedulerId}/shifts.

Start shift auto-assign (scheduler v1), via POST /scheduler/v1/schedulers/{schedulerId}/shifts/auto-assign. ASYNCHRONOUS. It answers with a request id and returns before any shift is assigned; poll 'Get a shift auto-assign request's status (scheduler v1)' with that id until it reports completion.

Create a scheduler unavailability, via POST /scheduler/v1/schedulers/{schedulerId}/unavailability.

Create shifts (scheduler v2), via POST /scheduler/v2/schedulers/{schedulerId}/shifts.

Start shift auto-assign (scheduler v2), via POST /scheduler/v2/schedulers/{schedulerId}/shifts/auto-assign. ASYNCHRONOUS. It answers with a request id and returns before any shift is assigned; poll 'Get a shift auto-assign request's status (scheduler v2)' with that id until it reports completion.

Create a webhook, via POST /settings/v1/webhooks.

Create a task, via POST /tasks/v1/taskboards/{taskBoardId}/tasks.

Create a subtask, via POST /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks.

Start a breadcrumbs (GPS trail) report, via POST /time-clock/breadcrumbs/v1/report. ASYNCHRONOUS, and it produces employee LOCATION HISTORY. It starts a report and answers with a file id; poll 'Get a breadcrumbs report's status' until it is ready, then 'Get a breadcrumbs report's download link'. Catalogued as a write because it creates a report artifact, though it changes no time-clock data.

Clock a user in, via POST /time-clock/v1/time-clocks/{timeClockId}/clock-in.

Clock a user out, via POST /time-clock/v1/time-clocks/{timeClockId}/clock-out.

Create geofences, via POST /time-clock/v1/time-clocks/{timeClockId}/geofences.

Start a manual break, via POST /time-clock/v1/time-clocks/{timeClockId}/manual-breaks/{manualBreakId}/clock-in.

End a manual break, via POST /time-clock/v1/time-clocks/{timeClockId}/manual-breaks/clock-out.

Create time activities, via POST /time-clock/v1/time-clocks/{timeClockId}/time-activities.

Create a time-off request, via POST /time-off/v1/requests.

Invite an admin, via POST /users/v1/admins. GRANTS ADMINISTRATIVE ACCESS to the Connecteam account. An invited admin can see and change what admins can see and change -- including, on an owner-level account, the API settings this connection's own key lives in. Catalogued as a write because it creates a record; read it as a permission change.

Create user custom fields, via POST /users/v1/custom-fields.

Add options to a user custom field, via POST /users/v1/custom-fields/{customFieldId}/options.

Create pending users, via POST /users/v1/pending-users.

Create a smart group segment, via POST /users/v1/smart-group-segments.

Create a smart group, via POST /users/v1/smart-groups.

Create users, via POST /users/v1/users. BULK CREATE over a JSON ARRAY. Creating a user in Connecteam can send them an invitation, so this reaches real people; check the array before sending it rather than after.

Add a note to a user, via POST /users/v1/users/{userId}/notes.

Add a payslip to a user, via POST /users/v1/users/{userId}/payslips. Attaches a payslip document to one employee. Payroll data about an identifiable person: the file arrives through the attachments flow, and who can read it afterwards is Connecteam's own permission model, not this connection's action picker.

Finish a file upload, via PUT /attachments/v1/files/complete-upload/{fileId}. STEP 3 OF 3: tells Connecteam the bytes have landed at the signed URL 'Start a file upload' issued. Calling it before the upload finished registers a file that is not there.

Assign a user to a pay rule policy, via PUT /company-policies/v1/pay-rule-policies/{payRulePolicyId}/assignments.

Add a pay rule to a pay rule policy, via PUT /company-policies/v1/pay-rule-policies/{payRulePolicyId}/pay-rules/{payRuleId}.

Assign users to a scheduling rule policy, via PUT /company-policies/v1/scheduling-rule-policies/{schedulingRulePolicyId}/assignments.

Set a user's custom working hours, via PUT /company-policies/v1/users/{userId}/working-hours.

Assign users to a working hours policy, via PUT /company-policies/v1/working-hours-policies/{workingHoursPolicyId}/assignments.

Update a daily note, via PUT /daily-info/v1/daily-note/{noteId}.

Update a form submission, via PUT /forms/v1/forms/{formId}/form-submissions/{formSubmissionId}.

Update a dropdown option, via PUT /forms/v1/forms/{formId}/questions/{questionId}/options/{optionId}.

Update a job, via PUT /jobs/v1/jobs/{jobId}.

Set pay rates, via PUT /pay-rates/v1/pay-rates. Writes what people are PAID, effective from a date. It is an upsert over the ids in the body rather than a patch of one row, so send the whole intended state for each user; a partial body is a pay change, not a no-op.

Set a location's projected daily sales, via PUT /sales/v1/locations/{locationId}/daily-sales.

Update shifts (scheduler v1), via PUT /scheduler/v1/schedulers/{schedulerId}/shifts.

Update shifts (scheduler v2), via PUT /scheduler/v2/schedulers/{schedulerId}/shifts.

Update a webhook, via PUT /settings/v1/webhooks/{webhookId}.

Update a task, via PUT /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}.

Update a subtask, via PUT /tasks/v1/taskboards/{taskBoardId}/tasks/{taskId}/sub-tasks/{subTaskId}.

Update time activities, via PUT /time-clock/v1/time-clocks/{timeClockId}/time-activities.

Lock or unlock a user's timesheet days, via PUT /time-clock/v1/time-clocks/{timeClockId}/users/{userId}/lock-days. Locking a day freezes that user's timesheet for it -- neither they nor an admin can edit those hours until it is unlocked -- which is normally done once payroll has been run. The same tool unlocks.

Set a user's time-off balance, via PUT /time-off/v1/policy-types/{policyTypeId}/balances/{userId}. Sets a balance to a value rather than adding to it, so a read-modify-write built on a stale read silently overwrites whatever accrued in between.

Update a time-off request, via PUT /time-off/v1/requests/{requestId}.

Assign a user to a time-off policy, via PUT /time-off/v1/time-off-policies/{timeOffPolicyId}/assignments.

Update user custom fields, via PUT /users/v1/custom-fields.

Update a user custom field option, via PUT /users/v1/custom-fields/{customFieldId}/options/{optionId}.

Update pending users' status, in bulk, via PUT /users/v1/pending-users. BULK, and this is the STATUS transition rather than the field edit -- it is how an invitation is resent or withdrawn across several pending users at once. Use 'Update a pending user' to change one person's details.

Update a pending user, via PUT /users/v1/pending-users/{pendingUserId}.

Update a smart group, via PUT /users/v1/smart-groups/{smartGroupId}.

Update users, via PUT /users/v1/users. BULK UPDATE over a JSON ARRAY of users, each naming its own id. Fields you omit for a user are left alone, but every user in the array is written, so an array assembled from a stale read writes stale values back.

Set a user's performance for one date, via PUT /users/v1/users/{userId}/performance/{date}.