# Connecteam

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/connecteam

## Actions

### Create task

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

**Inputs**

- Task board (`task_board_id`, text, required): Choose a task board.
- Title (`title`, text, required): Task title.
- Status (`status`, text, required): Choose whether to save a draft, publish, or mark the new task complete. One of: `draft`, `published`, `completed`.
- Assignees (`assignees`, list): Choose one or more users. Multiple users share one group task.
- Description (`description`, text): Task details.
- Start time (`start_time`, date and time): When the task starts.
- Due date (`due_date`, date and time): When the task is due.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "status": "example",
      "title": "example"
    }
  }
}
```

### Delete task

Delete a task from the selected task board.

**Inputs**

- Task board (`task_board_id`, text, required): Choose a task board.
- Task ID (`task_id`, text, required): Task ID from List tasks or Create task.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Get account

Get account.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "companyId": "example",
      "companyName": "example"
    },
    "requestId": "example"
  }
}
```

### Get form

Get form.

**Inputs**

- Form (`form_id`, number, required): Form id to return

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "createdAt": 1,
      "formId": 1,
      "formName": "example",
      "lastUpdatedAt": 1,
      "questions": [
        {}
      ],
      "settings": {}
    },
    "requestId": "example"
  }
}
```

### Get form submission

Get form submission.

**Inputs**

- Form (`form_id`, number, required): Form Id
- Form submission ID (`form_submission_id`, text, required): Filter by Form submission id

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "formSubmission": {
        "formId": 1,
        "formSubmissionId": "example"
      }
    },
    "requestId": "example"
  }
}
```

### Get job

Get job.

**Inputs**

- Job (`job_id`, text, required): The unique identifier of the job

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "job": {
        "jobId": "example",
        "title": "example"
      }
    },
    "requestId": "example"
  }
}
```

### Get timesheet totals

Get timesheet totals.

**Inputs**

- Time clock (`time_clock_id`, number, required): The unique identifier of the time clock
- Start date (`start_date`, date, required): 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_date`, date, required): 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**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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_id`, number, required): Filter by Form Id
- Submitting start timestamp (`submitting_start_timestamp`, date and time): Filter form submissions that were submitted from this timestamp
- Submitting end time (`submitting_end_time`, date and time): Filter form submissions that were submitted until this timestamp
- Limit (`limit`, number): The maximum number of results to display per page. From 1 to 100.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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 (`name`, text): The name of the form to filter by (partial, case-insensitive match)
- Start date (`start_date`, date): Filter forms created on or after this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.
- End date (`end_date`, date): Filter forms created on or before this date (form creation date) in ISO 8601 format (YYYY-MM-DD). Inclusive.
- Limit (`limit`, number): The maximum number of results to display per page. From 1 to 300.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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_deleted`, true/false): Determines whether the response includes jobs that have been deleted. Default value is set to true.
- Limit (`limit`, number): The maximum number of results to display per page. From 1 to 500.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "jobs": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}
```

### List smart groups

List smart groups.

**Inputs**

- Name (`name`, text): The name of the smart group to filter by.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "groups": [
        {}
      ]
    },
    "requestId": "example"
  }
}
```

### List subtasks

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

**Inputs**

- Task board (`task_board_id`, text, required): The unique identifier of the task board
- Task ID (`task_id`, text, required): The unique identifier of the parent task
- Limit (`limit`, number): The maximum number of results to display per page. From 1 to 100.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "subTasks": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}
```

### List task boards

List task boards.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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_id`, text, required): The unique identifier of the task board to filter by
- Limit (`limit`, number): The maximum number of results to display per page. From 1 to 100.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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_id`, text, required): The unique identifier of the taskBoard
- Status (`status`, text): draft/published/completed/all - all is by default. One of: `draft`, `published`, `completed`, `all`.
- Limit (`limit`, number): The maximum number of results to display per page. From 1 to 100.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "tasks": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}
```

### List time activities

List time activities.

**Inputs**

- Time clock (`time_clock_id`, number, required): The unique identifier of the time clock
- Start date (`start_date`, date, required): The start time to filter by in ISO 8601 format (YYYY-MM-DD)
- End date (`end_date`, date, required): The end time to filter by in ISO 8601 format (YYYY-MM-DD)

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "timeActivitiesByUsers": [
        {}
      ]
    },
    "requestId": "example"
  }
}
```

### List time clocks

List time clocks.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "timeClocks": [
        {}
      ]
    },
    "requestId": "example"
  }
}
```

### List time-off policies

List time-off policies.

**Inputs**: None.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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_date`, date, required): Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned.
- End date (`end_date`, date, required): 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 (`statuses`, list): 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 (`limit`, number): The maximum number of results to display per page. From 1 to 100.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "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 (`limit`, number): The maximum number of results to display per page. From 1 to 500.
- Offset (`offset`, number): Offset returned by the previous page. At least 0.
- User status (`user_status`, text): Filter users by status. Default is active. One of: `active`, `archived`, `all`.
- Email addresses (`email_addresses`, list): List of email addresses to filter by (in format test@test.com).
- Created at (`created_at`, date and time): Return users whose creation is at or after this time.
- Modified at (`modified_at`, date and time): Return users whose last update is at or after this time.

**Outputs**

- `data` (object): The response from Connecteam.

**Example output**

```json
{
  "data": {
    "data": {
      "users": [
        {}
      ]
    },
    "paging": {
      "offset": 1,
      "total": 1
    },
    "requestId": "example"
  }
}
```
