Read Connecteam users, shifts, time clock, jobs, time off, tasks and forms; create shifts and tasks.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: create ONE shift in a scheduler (one assignee or one open spot: the V1 endpoint does not create group or multi-spot shifts). By default it is created as an unpublished draft (employees see nothing). With is_published=true it is published, and Connecteam notifies the assigned users unless notify_users=false. Give a title or a job_id (Connecteam requires one). For an open shift set is_open_shift=true and leave assigned_user_ids empty. POST /scheduler/v1/schedulers/{schedulerId}/shifts.
Shift end: Unix seconds or ISO 8601 date-time with zone.
Shift start: Unix seconds or ISO 8601 date-time with zone.
Scheduler id (connecteam_list_schedulers).
A plain-text note shown on the shift.
Shift color from Connecteam's palette; defaults to the job's color (or #4B7AC5).
Shift title (required unless job_id is given).
Job id (connecteam_list_jobs) to attach the shift to.
IANA time zone, e.g. America/New_York (default: the account's time zone).
Shift tasks (checklist items) by title.
Publish the shift now (default false = draft).
For a published shift: notify the assigned users (Connecteam default true).
Create an open shift with one spot that an employee can claim (default false).
The user id to assign (at most one: the V1 endpoint rejects more); empty for an open shift.
Claiming needs admin approval (open shifts only).
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE: create ONE shift in a scheduler (one assignee or one open spot: the V1 endpoint does not create group or multi-spot shifts). By default it is created as an unpublished draft (employees see nothing). With is_published=true it is published, and Connecteam notifies the assigned users unless notify_users=false. Give a title or a job_id (Connecteam requires one). For an open shift set is_open_shift=true and leave assigned_user_ids empty. POST /scheduler/v1/schedulers/{schedulerId}/shifts.
| Argument | Type | Description |
|---|---|---|
| note | string | A plain-text note shown on the shift. |
| color | string | Shift color from Connecteam's palette; defaults to the job's color (or #4B7AC5). |
| title | string | Shift title (required unless job_id is given). |
| job_id | string | Job id (connecteam_list_jobs) to attach the shift to. |
| end_time* | any | Shift end: Unix seconds or ISO 8601 date-time with zone. |
| timezone | string | IANA time zone, e.g. America/New_York (default: the account's time zone). |
| start_time* | any | Shift start: Unix seconds or ISO 8601 date-time with zone. |
| task_titles | array | Shift tasks (checklist items) by title. |
| is_published | boolean | Publish the shift now (default false = draft). |
| notify_users | boolean | For a published shift: notify the assigned users (Connecteam default true). |
| scheduler_id* | integer | Scheduler id (connecteam_list_schedulers). |
| is_open_shift | boolean | Create an open shift with one spot that an employee can claim (default false). |
| assigned_user_ids | array | The user id to assign (at most one: the V1 endpoint rejects more); empty for an open shift. |
| require_admin_approval | boolean | Claiming needs admin approval (open shifts only). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"scheduler_id",
"start_time",
"end_time"
],
"properties": {
"note": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "A plain-text note shown on the shift."
},
"color": {
"enum": [
"#4B7AC5",
"#801A1A",
"#AE2121",
"#DC7A7A",
"#B0712E",
"#D4985A",
"#E4B37F",
"#AE8E2D",
"#CBA73A",
"#D9B443",
"#487037",
"#6F9B5C",
"#91B282",
"#365C64",
"#5687B3",
"#7C9BA2",
"#3968BB",
"#85A6DA",
"#225A8C",
"#548CBE",
"#81A8CC",
"#4E3F75",
"#604E8E",
"#8679AA",
"#983D73",
"#A43778",
"#D178AD",
"#6B2E4C",
"#925071",
"#B57D9A",
"#3a3a3a",
"#616161",
"#969696"
],
"type": "string",
"description": "Shift color from Connecteam's palette; defaults to the job's color (or #4B7AC5)."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Shift title (required unless job_id is given)."
},
"job_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Job id (connecteam_list_jobs) to attach the shift to."
},
"end_time": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Shift end: Unix seconds or ISO 8601 date-time with zone."
},
"timezone": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "IANA time zone, e.g. America/New_York (default: the account's time zone)."
},
"start_time": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Shift start: Unix seconds or ISO 8601 date-time with zone."
},
"task_titles": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 30,
"description": "Shift tasks (checklist items) by title."
},
"is_published": {
"type": "boolean",
"description": "Publish the shift now (default false = draft)."
},
"notify_users": {
"type": "boolean",
"description": "For a published shift: notify the assigned users (Connecteam default true)."
},
"scheduler_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Scheduler id (connecteam_list_schedulers).",
"exclusiveMinimum": 0
},
"is_open_shift": {
"type": "boolean",
"description": "Create an open shift with one spot that an employee can claim (default false)."
},
"assigned_user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 1,
"description": "The user id to assign (at most one: the V1 endpoint rejects more); empty for an open shift."
},
"require_admin_approval": {
"type": "boolean",
"description": "Claiming needs admin approval (open shifts only)."
}
}
}WRITE: create one quick task on a task board for the given users. status 'draft' keeps it hidden; 'published' sends it to the assignees' apps. Several user ids make one group task. POST /tasks/v1/taskboards/{taskBoardId}/tasks.
| Argument | Type | Description |
|---|---|---|
| title* | string | Task title. |
| status* | string | 'draft' (not visible to employees) or 'published' (sent to the assignees). |
| due_date | any | Due: Unix seconds or ISO 8601 date-time with zone. |
| user_ids* | array | Assignee user ids (several = one group task). |
| label_ids | array | Label ids (connecteam_list_task_labels). |
| sub_tasks | array | Sub-task titles. |
| start_time | any | Start: Unix seconds or ISO 8601 date-time with zone. |
| description | string | Task description (plain text). |
| task_board_id |
The Connecteam company this API key belongs to: company name and company id. GET /me.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}One job by id, with its sub-jobs, assignments and location. GET /jobs/v1/jobs/{jobId}.
| Argument | Type | Description |
|---|---|---|
| job_id* | string | Job id (from connecteam_list_jobs). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Job id (from connecteam_list_jobs)."
}
}
}One shift of a scheduler by its id, with assignments, statuses, breaks, notes and tasks. GET /scheduler/v1/schedulers/{schedulerId}/shifts/{shiftId}.
| Argument | Type | Description |
|---|---|---|
| shift_id* | string | Shift id (from connecteam_list_shifts). |
| scheduler_id* | integer | Scheduler id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"scheduler_id",
"shift_id"
],
"properties": {
"shift_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Shift id (from connecteam_list_shifts)."
},
"scheduler_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Scheduler id.",
"exclusiveMinimum": 0
}
}
}Payroll-ready timesheet totals of a time clock for a date range (at most 45 days, Connecteam's limit): per user and day, total/work/paid-break/unpaid-break hours (decimal), approved/submitted/locked flags and pay items by pay rule (with pay rates when defined). Filter by users, groups, jobs or approval state. GET /time-clock/v1/time-clocks/{timeClockId}/timesheet.
| Argument | Type | Description |
|---|---|---|
| job_ids | array | Only these (parent or regular) job ids. |
| end_date* | string | Last date (yyyy-mm-dd), up to 23:59:59; at most 45 days after start_date. |
| user_ids | array | Only these user ids. |
| group_ids | array | Only users in these smart group ids. |
| is_locked | boolean | true = locked only, false = unlocked only. |
| start_date* | string | First date (yyyy-mm-dd), from 00:00:00. |
| is_approved | boolean | true = approved days only, false = unapproved only. |
| is_submitted | boolean |
List the submissions of one form: who submitted and when, the answers and the manager fields (status, owner, notes). Filter by submitting users and time window. GET /forms/v1/forms/{formId}/form-submissions.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| form_id* | integer | Form id (connecteam_list_forms). |
| user_ids | array | Only submissions by these user ids. |
| submitted_to | any | Submitted at or before: Unix seconds or ISO 8601 date-time with zone. |
| submitted_from | any | Submitted at or after: Unix seconds or ISO 8601 date-time with zone. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"form_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"form_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Form id (connecteam_list_forms).",
"exclusiveMinimum": 0
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only submissions by these user ids."
},
"submitted_to": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Submitted at or before: Unix seconds or ISO 8601 date-time with zone."
},
"submitted_from": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Submitted at or after: Unix seconds or ISO 8601 date-time with zone."
}
}
}List forms (checklists, inspections, reports) with their questions. Filter by name or creation date. GET /forms/v1/forms.
| Argument | Type | Description |
|---|---|---|
| name | string | Name contains (case-insensitive). |
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| created_to | string | Created on or before (yyyy-mm-dd). |
| created_from | string | Created on or after (yyyy-mm-dd). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Name contains (case-insensitive)."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"created_to": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Created on or before (yyyy-mm-dd)."
},
"created_from": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Created on or after (yyyy-mm-dd)."
}
}
}List jobs (the work items shifts and time are tracked against): id, title, code, color, description, GPS/geofence, assigned users/groups, parent job and sub-jobs, and the schedulers/time clocks (instance ids) they belong to. GET /jobs/v1/jobs.
| Argument | Type | Description |
|---|---|---|
| sort | string | Sort key. |
| limit | integer | Results per page, 1-100 (default 25). |
| order | string | Sort order (only with a sort key). |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| job_ids | array | Only these job ids (a parent id also returns its sub-jobs). |
| job_codes | array | Only jobs with these codes. |
| job_names | array | Only jobs with these titles. |
| instance_ids | array | Only jobs of these scheduler or time clock ids. |
| include_deleted | boolean |
List the job schedulers (schedules) in the account with their id, name, time zone and archived state. The scheduler id is needed to list or create shifts. GET /scheduler/v1/schedulers.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List shifts of one scheduler in a time window (one row per assigned user, as Connecteam's V1 endpoint returns them): title, start/end (Unix seconds), time zone, assigned user ids, open-shift spots, job, location, published state, statuses, breaks, notes and shift tasks. Filter by assigned users, job, open or published. GET /scheduler/v1/schedulers/{schedulerId}/shifts.
| Argument | Type | Description |
|---|---|---|
| sort | string | Sort key. |
| limit | integer | Results per page, 1-100 (default 25). |
| order | string | Sort order (only with a sort key). |
| title | string | Only shifts with this title. |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| job_ids | array | Only shifts of these job ids. |
| end_time* | any | Window end: Unix seconds or ISO 8601 date-time with zone. |
| shift_ids | array | Only these shift ids. |
List the quick-task boards in the account (id, name, archived). The board id is needed to list or create tasks. GET /tasks/v1/taskboards.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List the labels of a task board (id, name, color), for filtering tasks or labelling a new one. GET /tasks/v1/taskboards/{taskBoardId}/labels.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| title | string | Only the label with this name. |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| task_board_id* | string | Task board id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"task_board_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the label with this name."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"task_board_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Task board id."
}
}
}List tasks on a task board: title, assigned user ids, status (draft/published/completed), start and due time (Unix seconds), labels, sub-tasks and description. Filter by status, users, labels or task ids. GET /tasks/v1/taskboards/{taskBoardId}/tasks.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| status | string | Status filter (default all). |
| task_ids | array | Only these task ids. |
| user_ids | array | Only tasks assigned to these user ids (group tasks are included). |
| label_ids | array | Only tasks carrying these label ids. |
| task_board_id* | string | Task board id (connecteam_list_task_boards). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"task_board_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"status": {
"enum": [
"draft",
"published",
"completed",
"all"
],
"type": "string",
"description": "Status filter (default all)."
},
"task_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only these task ids."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only tasks assigned to these user ids (group tasks are included)."
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only tasks carrying these label ids."
},
"task_board_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Task board id (connecteam_list_task_boards)."
}
}
}Clock-in/clock-out records of a time clock for a date range (at most 31 days per call), grouped by user: worked shifts (start/end, job, sub-job, notes, auto clock-out), manual breaks and time off. Filter by users, jobs or activity type. GET /time-clock/v1/time-clocks/{timeClockId}/time-activities.
| Argument | Type | Description |
|---|---|---|
| job_ids | array | Only shifts of these job ids. |
| end_date* | string | Last date (yyyy-mm-dd), at most 31 days after start_date. |
| user_ids | array | Only these user ids (users still assigned to the time clock). |
| start_date* | string | First date (yyyy-mm-dd). |
| time_clock_id* | integer | Time clock id (connecteam_list_time_clocks). |
| activity_types | array | Only these activity types. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"time_clock_id",
"start_date",
"end_date"
],
"properties": {
"job_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only shifts of these job ids."
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Last date (yyyy-mm-dd), at most 31 days after start_date."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these user ids (users still assigned to the time clock)."
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First date (yyyy-mm-dd)."
},
"time_clock_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Time clock id (connecteam_list_time_clocks).",
"exclusiveMinimum": 0
},
"activity_types": {
"type": "array",
"items": {
"enum": [
"shift",
"manual_break",
"time_off"
],
"type": "string"
},
"maxItems": 3,
"description": "Only these activity types."
}
}
}List the time clocks in the account (id, name, archived). The time clock id is needed for time activities and timesheets. GET /time-clock/v1/time-clocks.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List time-off policy types (e.g. Vacation, Sick) and their policies with unit (hours/days) and accrual type. Needs the HR & Skills hub. GET /time-off/v1/policy-types.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List time-off requests overlapping a date range (at most 365 days): user, policy type, dates/times, all-day flag, status (approved/pending/denied), notes, approving manager and, for approved requests, the amount deducted. Connecteam returns only approved requests unless statuses is given. Needs the HR & Skills hub. GET /time-off/v1/requests.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| end_date* | string | Range end (yyyy-mm-dd), inclusive; at most 365 days after start_date. |
| statuses | array | Statuses to include (default: approved only). |
| user_ids | array | Only these user ids. |
| start_date* | string | Range start (yyyy-mm-dd), inclusive. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"start_date",
"end_date"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range end (yyyy-mm-dd), inclusive; at most 365 days after start_date."
},
"statuses": {
"type": "array",
"items": {
"enum": [
"approved",
"pending",
"denied"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Statuses to include (default: approved only)."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these user ids."
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Range start (yyyy-mm-dd), inclusive."
}
}
}List employees (users): name, email, phone, user type (user/manager/owner), archived state, smart groups, custom fields and last login. Use it to map the user ids in shifts, time activities, timesheets, time off and tasks to names. Kiosk codes and device ids are never returned. GET /users/v1/users.
| Argument | Type | Description |
|---|---|---|
| sort | string | Sort key. |
| limit | integer | Results per page, 1-100 (default 25). |
| order | string | Sort order (only with a sort key). |
| emails | array | Exact email addresses. |
| offset | integer | Index of the first result (default 0); pass the previous reply's next_offset. |
| status | string | User status filter (Connecteam default: active). |
| user_ids | array | Only these user ids. |
| full_names | array | Exact full names ('First Last', case-insensitive). |
| phone_numbers | array |
| string |
| Task board id (connecteam_list_task_boards). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"task_board_id",
"title",
"user_ids",
"status"
],
"properties": {
"title": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Task title."
},
"status": {
"enum": [
"draft",
"published"
],
"type": "string",
"description": "'draft' (not visible to employees) or 'published' (sent to the assignees)."
},
"due_date": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Due: Unix seconds or ISO 8601 date-time with zone."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"minItems": 1,
"description": "Assignee user ids (several = one group task)."
},
"label_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 20,
"description": "Label ids (connecteam_list_task_labels)."
},
"sub_tasks": {
"type": "array",
"items": {
"type": "string",
"maxLength": 500,
"minLength": 1
},
"maxItems": 50,
"description": "Sub-task titles."
},
"start_time": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Start: Unix seconds or ISO 8601 date-time with zone."
},
"description": {
"type": "string",
"maxLength": 10000,
"minLength": 1,
"description": "Task description (plain text)."
},
"task_board_id": {
"type": "string",
"maxLength": 128,
"minLength": 1,
"description": "Task board id (connecteam_list_task_boards)."
}
}
}| true = submitted only, false = unsubmitted only. |
| time_clock_id* | integer | Time clock id (connecteam_list_time_clocks). |
| include_plan_vs_actual | boolean | Add scheduled-vs-actual details per day (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"time_clock_id",
"start_date",
"end_date"
],
"properties": {
"job_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only these (parent or regular) job ids."
},
"end_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Last date (yyyy-mm-dd), up to 23:59:59; at most 45 days after start_date."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these user ids."
},
"group_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only users in these smart group ids."
},
"is_locked": {
"type": "boolean",
"description": "true = locked only, false = unlocked only."
},
"start_date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "First date (yyyy-mm-dd), from 00:00:00."
},
"is_approved": {
"type": "boolean",
"description": "true = approved days only, false = unapproved only."
},
"is_submitted": {
"type": "boolean",
"description": "true = submitted only, false = unsubmitted only."
},
"time_clock_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Time clock id (connecteam_list_time_clocks).",
"exclusiveMinimum": 0
},
"include_plan_vs_actual": {
"type": "boolean",
"description": "Add scheduled-vs-actual details per day (default false)."
}
}
}| Include deleted jobs (Connecteam default: true). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort": {
"enum": [
"title"
],
"type": "string",
"description": "Sort key."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order (only with a sort key)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"job_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only these job ids (a parent id also returns its sub-jobs)."
},
"job_codes": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 50,
"description": "Only jobs with these codes."
},
"job_names": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"description": "Only jobs with these titles."
},
"instance_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only jobs of these scheduler or time clock ids."
},
"include_deleted": {
"type": "boolean",
"description": "Include deleted jobs (Connecteam default: true)."
}
}
}| start_time* |
| any |
| Window start: Unix seconds or ISO 8601 date-time with zone. |
| is_published | boolean | true = only published shifts, false = only drafts. |
| scheduler_id* | integer | Scheduler id (connecteam_list_schedulers). |
| is_open_shift | boolean | true = only open shifts, false = only assigned shifts. |
| assigned_user_ids | array | Only shifts assigned to these user ids. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"scheduler_id",
"start_time",
"end_time"
],
"properties": {
"sort": {
"enum": [
"created_at",
"updated_at"
],
"type": "string",
"description": "Sort key."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order (only with a sort key)."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only shifts with this title."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"job_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only shifts of these job ids."
},
"end_time": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Window end: Unix seconds or ISO 8601 date-time with zone."
},
"shift_ids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 128,
"minLength": 1
},
"maxItems": 100,
"description": "Only these shift ids."
},
"start_time": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Window start: Unix seconds or ISO 8601 date-time with zone."
},
"is_published": {
"type": "boolean",
"description": "true = only published shifts, false = only drafts."
},
"scheduler_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Scheduler id (connecteam_list_schedulers).",
"exclusiveMinimum": 0
},
"is_open_shift": {
"type": "boolean",
"description": "true = only open shifts, false = only assigned shifts."
},
"assigned_user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only shifts assigned to these user ids."
}
}
}| Phone numbers in +<country code><number> format. |
| modified_since | any | Only users changed after this time (Unix seconds or ISO 8601 date-time with zone). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sort": {
"enum": [
"created_at"
],
"type": "string",
"description": "Sort key."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Results per page, 1-100 (default 25)."
},
"order": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort order (only with a sort key)."
},
"emails": {
"type": "array",
"items": {
"type": "string",
"maxLength": 254,
"minLength": 3
},
"maxItems": 50,
"description": "Exact email addresses."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Index of the first result (default 0); pass the previous reply's next_offset."
},
"status": {
"enum": [
"active",
"archived",
"all"
],
"type": "string",
"description": "User status filter (Connecteam default: active)."
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these user ids."
},
"full_names": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"description": "Exact full names ('First Last', case-insensitive)."
},
"phone_numbers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 32,
"minLength": 3
},
"maxItems": 50,
"description": "Phone numbers in +<country code><number> format."
},
"modified_since": {
"anyOf": [
{
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
{
"type": "string"
}
],
"description": "Only users changed after this time (Unix seconds or ISO 8601 date-time with zone)."
}
}
}