Connecteam

App · 20 actions

Read workforce records, jobs, forms, timesheets and time off, and manage tasks.

Actions

ActionWhat it does
Create taskCreate a task on a task board.
Delete taskDelete a task from the selected task board.
Get accountGet account.
Get formGet form.
Get form submissionGet form submission.
Get jobGet job.
Get timesheet totalsGet timesheet totals.
List form submissionsList form submissions.
List formsList forms.
List jobsList jobs.
List smart groupsList smart groups.
List subtasksList subtasks.
List task boardsList task boards.
List task labelsList task labels.
List tasksList tasks.
List time activitiesList time activities.
List time clocksList time clocks.
List time-off policiesList time-off policies.
List time-off requestsList time-off requests.
List usersList users.

Create task

Create a task on a task board. A draft can be left unassigned.

Inputs

Task boardtask_board_idtextRequired
Choose a task board.
TitletitletextRequired
Task title.
StatusstatustextRequired
Choose whether to save a draft, publish, or mark the new task complete.One of: draft, published, completed.
Assigneesassigneeslist
Choose one or more users. Multiple users share one group task.
Descriptiondescriptiontext
Task details.
Start timestart_timedate and time
When the task starts.
Due datedue_datedate and time
When the task is due.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "status": "example",
      "title": "example"
    }
  }
}

Delete task

Delete a task from the selected task board.

Inputs

Task boardtask_board_idtextRequired
Choose a task board.
Task IDtask_idtextRequired
Task ID from List tasks or Create task.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {}
  }
}

Get account

Get account.

Inputs

None.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "companyId": "example",
      "companyName": "example"
    },
    "requestId": "example"
  }
}

Get form

Get form.

Inputs

Formform_idnumberRequired
Form id to return

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "createdAt": 1,
      "formId": 1,
      "formName": "example",
      "lastUpdatedAt": 1,
      "questions": [
        {}
      ],
      "settings": {}
    },
    "requestId": "example"
  }
}

Get form submission

Get form submission.

Inputs

Formform_idnumberRequired
Form Id
Form submission IDform_submission_idtextRequired
Filter by Form submission id

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "formSubmission": {
        "formId": 1,
        "formSubmissionId": "example"
      }
    },
    "requestId": "example"
  }
}

Get job

Get job.

Inputs

Jobjob_idtextRequired
The unique identifier of the job

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "job": {
        "jobId": "example",
        "title": "example"
      }
    },
    "requestId": "example"
  }
}

Get timesheet totals

Get timesheet totals.

Inputs

Time clocktime_clock_idnumberRequired
The unique identifier of the time clock
Start datestart_datedateRequired
The start of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records from 00:00:00 on the specified date. Example: A startDate of 2025-01-01 includes data starting from 2025-01-01T00:00:00
End dateend_datedateRequired
The end of the reporting period, in ISO 8601 format (YYYY-MM-DD). The filter includes all records up to 23:59:59 on the specified date. Example: An endDate of 2025-01-01 includes data up to 2025-01-01T23:59:59. The end date must be no more than 45 days after the start date. If there is an ongoing overnight shift that continues past the end date, the hours of the overnight will only be included if it has been configured in the time clock settings.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "endDate": "example",
      "startDate": "example",
      "users": [
        {}
      ]
    },
    "requestId": "example"
  }
}

List form submissions

List form submissions. Use the returned offset to request the next page.

Inputs

Formform_idnumberRequired
Filter by Form Id
Submitting start timestampsubmitting_start_timestampdate and time
Filter form submissions that were submitted from this timestamp
Submitting end timesubmitting_end_timedate and time
Filter form submissions that were submitted until this timestamp
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 100.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "formSubmissions": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List forms

List forms. Use the returned offset to request the next page.

Inputs

Namenametext
The name of the form to filter by (partial, case-insensitive match)
Start datestart_datedate
Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.
End dateend_datedate
Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 300.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "forms": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List jobs

List jobs. Use the returned offset to request the next page.

Inputs

Include deletedinclude_deletedtrue/false
Determines whether the response includes jobs that have been deleted. Default value is set to true.
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 500.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "jobs": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List smart groups

List smart groups.

Inputs

Namenametext
The name of the smart group to filter by.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "groups": [
        {}
      ]
    },
    "requestId": "example"
  }
}

List subtasks

List subtasks. Use the returned offset to request the next page.

Inputs

Task boardtask_board_idtextRequired
The unique identifier of the task board
Task IDtask_idtextRequired
The unique identifier of the parent task
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 100.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "subTasks": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List task boards

List task boards.

Inputs

None.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "taskBoards": [
        {}
      ]
    },
    "requestId": "example"
  }
}

List task labels

List task labels. Use the returned offset to request the next page.

Inputs

Task boardtask_board_idtextRequired
The unique identifier of the task board to filter by
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 100.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "labels": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List tasks

List tasks. Use the returned offset to request the next page.

Inputs

Task boardtask_board_idtextRequired
The unique identifier of the taskBoard
Statusstatustext
draft/published/completed/all - all is by defaultOne of: draft, published, completed, all.
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 100.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "tasks": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List time activities

List time activities.

Inputs

Time clocktime_clock_idnumberRequired
The unique identifier of the time clock
Start datestart_datedateRequired
The start time to filter by in ISO 8601 format (YYYY-MM-DD)
End dateend_datedateRequired
The end time to filter by in ISO 8601 format (YYYY-MM-DD)

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "timeActivitiesByUsers": [
        {}
      ]
    },
    "requestId": "example"
  }
}

List time clocks

List time clocks.

Inputs

None.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "timeClocks": [
        {}
      ]
    },
    "requestId": "example"
  }
}

List time-off policies

List time-off policies.

Inputs

None.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "policyTypes": [
        {}
      ]
    },
    "requestId": "example"
  }
}

List time-off requests

List time-off requests. Use the returned offset to request the next page.

Inputs

Start datestart_datedateRequired
Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned.
End dateend_datedateRequired
End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate. Range may not exceed 365 days.
Statusesstatuseslist
Filter by status. Allowed: approved, pending, denied. Repeat the param for multiple values. Defaults to ['approved'] when omitted.One or more of: approved, pending, denied.
Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 100.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "requests": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

List users

List users. Use the returned offset to request the next page.

Inputs

Limitlimitnumber
The maximum number of results to display per pageFrom 1 to 500.
Offsetoffsetnumber
Offset returned by the previous page.At least 0.
User statususer_statustext
Filter users by status. Default is active.One of: active, archived, all.
Email addressesemail_addresseslist
List of email addresses to filter by (in format test@test.com).
Created atcreated_atdate and time
Return users whose creation is at or after this time.
Modified atmodified_atdate and time
Return users whose last update is at or after this time.

Outputs

dataobject
The response from Connecteam.
Example output
{
  "data": {
    "data": {
      "users": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}

On this page