---
canonical_url: "https://docs.composio.dev/toolkits/7shifts"
markdown_url: "https://docs.composio.dev/toolkits/7shifts.md"
product: "platform"
version: null
last_updated: null
---

# 7shifts

7shifts is a restaurant team management platform for employee scheduling, time clocking, payroll, communication, and operational workflows.

- **Category:** human resources
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `7SHIFTS`
- **Version:** 00000000_00

## Tools

### Create Department

**Slug:** `7SHIFTS_CREATE_DEPARTMENT`

Create a department at a company location, optionally make it the location's default department, and return its new department ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Department name, up to 155 characters. Use a unique name for temporary fixtures. |
| `default` | boolean | Yes | Whether this department becomes the location's default department. Use false for isolated test fixtures. |
| `company_id` | integer | Yes | Company ID in which to create the department. |
| `location_id` | integer | Yes | Location ID that will own the department. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Department

**Slug:** `7SHIFTS_DELETE_DEPARTMENT`

Permanently delete a department, optionally transferring its roles and shifts to another department.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID that owns the department. |
| `transfer_to` | integer | No | Destination department ID for roles and shifts currently assigned to the deleted department; omit for an unused temporary department. |
| `department_id` | integer | Yes | Department ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Department

**Slug:** `7SHIFTS_GET_DEPARTMENT`

Return one department by company and department ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID that owns the department. |
| `department_id` | integer | Yes | Department ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Assignments

**Slug:** `7SHIFTS_GET_USER_ASSIGNMENTS`

Return one user's assigned locations, departments, and roles in a single read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | integer | Yes | User ID whose location, department, and role assignments to return. |
| `company_id` | integer | Yes | Company ID that owns the user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Companies

**Slug:** `7SHIFTS_LIST_COMPANIES`

Return companies available to the connected access token, including the company IDs needed by company-scoped tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modified_since` | string | No | Return only companies modified on or after this date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Departments

**Slug:** `7SHIFTS_LIST_DEPARTMENTS`

List one page of departments in a company, optionally filtered by location or modification date, with a cursor when more are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum departments to return in this page (1-200). |
| `cursor` | string | No | Opaque next_cursor from a previous response; omit for the first page. |
| `company_id` | integer | Yes | Company ID whose departments to return. |
| `location_id` | integer | No | Return departments belonging to this location. |
| `modified_since` | string | No | Return only departments modified on or after this date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Locations

**Slug:** `7SHIFTS_LIST_LOCATIONS`

List one page of locations in a company and return location IDs used to filter schedules, users, and departments, with a cursor when more are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum locations to return in this page (1-500). |
| `cursor` | string | No | Opaque next_cursor from a previous response; omit for the first page. |
| `deleted` | boolean | No | Whether to return deleted locations instead of active locations. |
| `company_id` | integer | Yes | Company ID whose locations to return. |
| `modified_since` | string | No | Return only locations modified on or after this date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Shifts

**Slug:** `7SHIFTS_LIST_SHIFTS`

List one page of scheduled shifts for a company with employee, location, department, role, time-range, publication-state, and open-shift filters, with a cursor when more are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `open` | boolean | No | Filter by whether shifts are open for workers to request. |
| `draft` | boolean | No | Return only unpublished draft shifts; overrides the deleted filter. |
| `limit` | integer | No | Maximum shifts in this page (1-500). |
| `cursor` | string | No | Opaque next_cursor from a previous response; omit for the first page. |
| `deleted` | boolean | No | Return published shifts that were deleted; cannot be combined with draft. |
| `end_gte` | string | No | Return shifts ending on or after this ISO 8601 date-time. |
| `end_lte` | string | No | Return shifts ending on or before this ISO 8601 date-time. |
| `role_id` | integer | No | Return shifts assigned to this role. |
| `sort_by` | string ("start" | "end") | No | Sort shifts by start or end time. |
| `user_id` | integer | No | Return shifts assigned to this user. |
| `sort_dir` | string ("asc" | "desc") | No | Sort direction. |
| `shift_ids` | array | No | Return only these shift IDs. Sent as one comma-separated query value. |
| `start_gte` | string | No | Return shifts starting on or after this ISO 8601 date-time. |
| `start_lte` | string | No | Return shifts starting on or before this ISO 8601 date-time. |
| `company_id` | integer | Yes | Company ID whose shifts to return. |
| `location_id` | integer | No | Return shifts at this location. |
| `department_id` | integer | No | Return shifts in this department. |
| `include_draft` | boolean | No | Include draft shifts with published shifts; overrides the deleted and draft filters. |
| `department_ids` | array | No | Return shifts in any of these departments. |
| `modified_since` | string | No | Return only shifts modified on or after this ISO 8601 date-time. |
| `include_deleted` | boolean | No | Include deleted shifts with other matching shifts. |
| `consider_tz_in_ranges` | boolean | No | Honor offsets in supplied start/end range date-times instead of treating them as local location time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `7SHIFTS_LIST_USERS`

List employees and administrators in a 7shifts company, with optional status, name, and one assignment filter. Returns one page and an opaque cursor when more users are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter by a partial or full employee name. |
| `limit` | integer | No | Maximum users to return in this page (1-500). |
| `cursor` | string | No | Opaque next_cursor from a previous response; omit for the first page. |
| `status` | string ("active" | "inactive") | No | Return only active or inactive users. |
| `role_id` | integer | No | Return users assigned to this role; do not combine with location_id or department_id. |
| `sort_by` | string | No | Provider-supported field and direction used to sort the page. |
| `company_id` | integer | Yes | Company ID whose users to return. |
| `location_id` | integer | No | Return users assigned to this location; do not combine with department_id or role_id. |
| `department_id` | integer | No | Return users assigned to this department; do not combine with location_id or role_id. |
| `modified_since` | string | No | Return only users modified on or after this date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Department

**Slug:** `7SHIFTS_UPDATE_DEPARTMENT`

Replace a department's name and default setting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Complete replacement name for the department. |
| `default` | boolean | Yes | Complete replacement for whether this is the location's default department. |
| `company_id` | integer | Yes | Company ID that owns the department. |
| `department_id` | integer | Yes | Department ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |