Connecteam MCP by usefulapi

The Connecteam company this API key belongs to: company name and company id. GET /me.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "user_ids": {
      "description": "Only these user ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "status": {
      "description": "User status filter (Connecteam default: active).",
      "type": "string",
      "enum": [
        "active",
        "archived",
        "all"
      ]
    },
    "full_names": {
      "description": "Exact full names ('First Last', case-insensitive).",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "emails": {
      "description": "Exact email addresses.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 254
      }
    },
    "phone_numbers": {
      "description": "Phone numbers in +<country code><number> format.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 3,
        "maxLength": 32
      }
    },
    "modified_since": {
      "description": "Only users changed after this time (Unix seconds or ISO 8601 date-time with zone).",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ]
    },
    "sort": {
      "description": "Sort key.",
      "type": "string",
      "enum": [
        "created_at"
      ]
    },
    "order": {
      "description": "Sort order (only with a sort key).",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "scheduler_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Scheduler id (connecteam_list_schedulers)."
    },
    "start_time": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ],
      "description": "Window start: Unix seconds or ISO 8601 date-time with zone."
    },
    "end_time": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ],
      "description": "Window end: Unix seconds or ISO 8601 date-time with zone."
    },
    "assigned_user_ids": {
      "description": "Only shifts assigned to these user ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "job_ids": {
      "description": "Only shifts of these job ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "shift_ids": {
      "description": "Only these shift ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "title": {
      "description": "Only shifts with this title.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "is_open_shift": {
      "description": "true = only open shifts, false = only assigned shifts.",
      "type": "boolean"
    },
    "is_published": {
      "description": "true = only published shifts, false = only drafts.",
      "type": "boolean"
    },
    "sort": {
      "description": "Sort key.",
      "type": "string",
      "enum": [
        "created_at",
        "updated_at"
      ]
    },
    "order": {
      "description": "Sort order (only with a sort key).",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "scheduler_id",
    "start_time",
    "end_time"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One shift of a scheduler by its id, with assignments, statuses, breaks, notes and tasks. GET /scheduler/v1/schedulers/{schedulerId}/shifts/{shiftId}.

{
  "type": "object",
  "properties": {
    "scheduler_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Scheduler id."
    },
    "shift_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Shift id (from connecteam_list_shifts)."
    }
  },
  "required": [
    "scheduler_id",
    "shift_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "scheduler_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Scheduler id (connecteam_list_schedulers)."
    },
    "start_time": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ],
      "description": "Shift start: Unix seconds or ISO 8601 date-time with zone."
    },
    "end_time": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ],
      "description": "Shift end: Unix seconds or ISO 8601 date-time with zone."
    },
    "title": {
      "description": "Shift title (required unless job_id is given).",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "job_id": {
      "description": "Job id (connecteam_list_jobs) to attach the shift to.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "assigned_user_ids": {
      "description": "The user id to assign (at most one: the V1 endpoint rejects more); empty for an open shift.",
      "maxItems": 1,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "is_open_shift": {
      "description": "Create an open shift with one spot that an employee can claim (default false).",
      "type": "boolean"
    },
    "require_admin_approval": {
      "description": "Claiming needs admin approval (open shifts only).",
      "type": "boolean"
    },
    "timezone": {
      "description": "IANA time zone, e.g. America/New_York (default: the account's time zone).",
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "is_published": {
      "description": "Publish the shift now (default false = draft).",
      "type": "boolean"
    },
    "notify_users": {
      "description": "For a published shift: notify the assigned users (Connecteam default true).",
      "type": "boolean"
    },
    "note": {
      "description": "A plain-text note shown on the shift.",
      "type": "string",
      "minLength": 1,
      "maxLength": 5000
    },
    "task_titles": {
      "description": "Shift tasks (checklist items) by title.",
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "color": {
      "description": "Shift color from Connecteam's palette; defaults to the job's color (or #4B7AC5).",
      "type": "string",
      "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"
      ]
    }
  },
  "required": [
    "scheduler_id",
    "start_time",
    "end_time"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "time_clock_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Time clock id (connecteam_list_time_clocks)."
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "First date (yyyy-mm-dd)."
    },
    "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": {
      "description": "Only these user ids (users still assigned to the time clock).",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "job_ids": {
      "description": "Only shifts of these job ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "activity_types": {
      "description": "Only these activity types.",
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "shift",
          "manual_break",
          "time_off"
        ]
      }
    }
  },
  "required": [
    "time_clock_id",
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "time_clock_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Time clock id (connecteam_list_time_clocks)."
    },
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "First date (yyyy-mm-dd), from 00:00:00."
    },
    "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": {
      "description": "Only these user ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "group_ids": {
      "description": "Only users in these smart group ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "job_ids": {
      "description": "Only these (parent or regular) job ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "is_approved": {
      "description": "true = approved days only, false = unapproved only.",
      "type": "boolean"
    },
    "is_submitted": {
      "description": "true = submitted only, false = unsubmitted only.",
      "type": "boolean"
    },
    "is_locked": {
      "description": "true = locked only, false = unlocked only.",
      "type": "boolean"
    },
    "include_plan_vs_actual": {
      "description": "Add scheduled-vs-actual details per day (default false).",
      "type": "boolean"
    }
  },
  "required": [
    "time_clock_id",
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "instance_ids": {
      "description": "Only jobs of these scheduler or time clock ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "job_ids": {
      "description": "Only these job ids (a parent id also returns its sub-jobs).",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "job_names": {
      "description": "Only jobs with these titles.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      }
    },
    "job_codes": {
      "description": "Only jobs with these codes.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "include_deleted": {
      "description": "Include deleted jobs (Connecteam default: true).",
      "type": "boolean"
    },
    "sort": {
      "description": "Sort key.",
      "type": "string",
      "enum": [
        "title"
      ]
    },
    "order": {
      "description": "Sort order (only with a sort key).",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One job by id, with its sub-jobs, assignments and location. GET /jobs/v1/jobs/{jobId}.

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Job id (from connecteam_list_jobs)."
    }
  },
  "required": [
    "job_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "start_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Range start (yyyy-mm-dd), inclusive."
    },
    "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."
    },
    "user_ids": {
      "description": "Only these user ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "statuses": {
      "description": "Statuses to include (default: approved only).",
      "minItems": 1,
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "approved",
          "pending",
          "denied"
        ]
      }
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "start_date",
    "end_date"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "task_board_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Task board id (connecteam_list_task_boards)."
    },
    "status": {
      "description": "Status filter (default all).",
      "type": "string",
      "enum": [
        "draft",
        "published",
        "completed",
        "all"
      ]
    },
    "user_ids": {
      "description": "Only tasks assigned to these user ids (group tasks are included).",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "label_ids": {
      "description": "Only tasks carrying these label ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "task_ids": {
      "description": "Only these task ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "task_board_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the labels of a task board (id, name, color), for filtering tasks or labelling a new one. GET /tasks/v1/taskboards/{taskBoardId}/labels.

{
  "type": "object",
  "properties": {
    "task_board_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Task board id."
    },
    "title": {
      "description": "Only the label with this name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "task_board_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "task_board_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Task board id (connecteam_list_task_boards)."
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500,
      "description": "Task title."
    },
    "user_ids": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      },
      "description": "Assignee user ids (several = one group task)."
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "published"
      ],
      "description": "'draft' (not visible to employees) or 'published' (sent to the assignees)."
    },
    "start_time": {
      "description": "Start: Unix seconds or ISO 8601 date-time with zone.",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ]
    },
    "due_date": {
      "description": "Due: Unix seconds or ISO 8601 date-time with zone.",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ]
    },
    "label_ids": {
      "description": "Label ids (connecteam_list_task_labels).",
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      }
    },
    "description": {
      "description": "Task description (plain text).",
      "type": "string",
      "minLength": 1,
      "maxLength": 10000
    },
    "sub_tasks": {
      "description": "Sub-task titles.",
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      }
    }
  },
  "required": [
    "task_board_id",
    "title",
    "user_ids",
    "status"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List forms (checklists, inspections, reports) with their questions. Filter by name or creation date. GET /forms/v1/forms.

{
  "type": "object",
  "properties": {
    "name": {
      "description": "Name contains (case-insensitive).",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "created_from": {
      "description": "Created on or after (yyyy-mm-dd).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "created_to": {
      "description": "Created on or before (yyyy-mm-dd).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

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.

{
  "type": "object",
  "properties": {
    "form_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Form id (connecteam_list_forms)."
    },
    "user_ids": {
      "description": "Only submissions by these user ids.",
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "submitted_from": {
      "description": "Submitted at or after: Unix seconds or ISO 8601 date-time with zone.",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ]
    },
    "submitted_to": {
      "description": "Submitted at or before: Unix seconds or ISO 8601 date-time with zone.",
      "anyOf": [
        {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        {
          "type": "string"
        }
      ]
    },
    "limit": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Index of the first result (default 0); pass the previous reply's next_offset.",
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    }
  },
  "required": [
    "form_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}