Connecteam
App · 20 actions
Read workforce records, jobs, forms, timesheets and time off, and manage tasks.
Actions
| Action | What it does |
|---|---|
| Create task | Create a task on a task board. |
| Delete task | Delete a task from the selected task board. |
| Get account | Get account. |
| Get form | Get form. |
| Get form submission | Get form submission. |
| Get job | Get job. |
| Get timesheet totals | Get timesheet totals. |
| List form submissions | List form submissions. |
| List forms | List forms. |
| List jobs | List jobs. |
| List smart groups | List smart groups. |
| List subtasks | List subtasks. |
| List task boards | List task boards. |
| List task labels | List task labels. |
| List tasks | List tasks. |
| List time activities | List time activities. |
| List time clocks | List time clocks. |
| List time-off policies | List time-off policies. |
| List time-off requests | List time-off requests. |
| List users | List users. |
Create task
Create a task on a task board. A draft can be left unassigned.
Inputs
- Task board
task_board_idtextRequired - Choose a task board.
- Title
titletextRequired - Task title.
- Status
statustextRequired - Choose whether to save a draft, publish, or mark the new task complete.One of:
draft,published,completed. - Assignees
assigneeslist - Choose one or more users. Multiple users share one group task.
- Description
descriptiontext - Task details.
- Start time
start_timedate and time - When the task starts.
- Due date
due_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 board
task_board_idtextRequired - Choose a task board.
- Task ID
task_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
- Form
form_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
- Form
form_idnumberRequired - Form Id
- Form submission ID
form_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
- Job
job_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 clock
time_clock_idnumberRequired - The unique identifier of the time clock
- Start date
start_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 date
end_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
- Form
form_idnumberRequired - Filter by Form Id
- Submitting start timestamp
submitting_start_timestampdate and time - Filter form submissions that were submitted from this timestamp
- Submitting end time
submitting_end_timedate and time - Filter form submissions that were submitted until this timestamp
- Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 100.
- Offset
offsetnumber - 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
- Name
nametext - The name of the form to filter by (partial, case-insensitive match)
- Start date
start_datedate - Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.
- End date
end_datedate - Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.
- Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 300.
- Offset
offsetnumber - 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 deleted
include_deletedtrue/false - Determines whether the response includes jobs that have been deleted. Default value is set to true.
- Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 500.
- Offset
offsetnumber - 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
- Name
nametext - 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 board
task_board_idtextRequired - The unique identifier of the task board
- Task ID
task_idtextRequired - The unique identifier of the parent task
- Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 100.
- Offset
offsetnumber - 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 board
task_board_idtextRequired - The unique identifier of the task board to filter by
- Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 100.
- Offset
offsetnumber - 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 board
task_board_idtextRequired - The unique identifier of the taskBoard
- Status
statustext - draft/published/completed/all - all is by defaultOne of:
draft,published,completed,all. - Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 100.
- Offset
offsetnumber - 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 clock
time_clock_idnumberRequired - The unique identifier of the time clock
- Start date
start_datedateRequired - The start time to filter by in ISO 8601 format (YYYY-MM-DD)
- End date
end_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 date
start_datedateRequired - Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned.
- End date
end_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.
- Statuses
statuseslist - 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. - Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 100.
- Offset
offsetnumber - 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
- Limit
limitnumber - The maximum number of results to display per pageFrom 1 to 500.
- Offset
offsetnumber - Offset returned by the previous page.At least 0.
- User status
user_statustext - Filter users by status. Default is active.One of:
active,archived,all. - Email addresses
email_addresseslist - List of email addresses to filter by (in format test@test.com).
- Created at
created_atdate and time - Return users whose creation is at or after this time.
- Modified at
modified_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"
}
}