> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 7shifts

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

![7shifts logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/7shifts.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=298954289cd386f43d4211174b9044fa)

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

## Tools

> [accordion] 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
>
> **name** `string` *required*
>
> Department name, up to 155 characters. Use a unique name for temporary fixtures.
>
> **default** `boolean` *required*
>
> Whether this department becomes the location's default department. Use false for isolated test fixtures.
>
> **company\_id** `integer` *required*
>
> Company ID in which to create the department.
>
> **location\_id** `integer` *required*
>
> Location ID that will own the department.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Department
>
> **Slug:** `7SHIFTS_DELETE_DEPARTMENT`
>
> Permanently delete a department, optionally transferring its roles and shifts to another department.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> Company ID that owns the department.
>
> **transfer\_to** `integer`
>
> Destination department ID for roles and shifts currently assigned to the deleted department; omit for an unused temporary department.
>
> **department\_id** `integer` *required*
>
> Department ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Department
>
> **Slug:** `7SHIFTS_GET_DEPARTMENT`
>
> Return one department by company and department ID.
>
> #### Input Parameters
>
> **company\_id** `integer` *required*
>
> Company ID that owns the department.
>
> **department\_id** `integer` *required*
>
> Department ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Assignments
>
> **Slug:** `7SHIFTS_GET_USER_ASSIGNMENTS`
>
> Return one user's assigned locations, departments, and roles in a single read.
>
> #### Input Parameters
>
> **user\_id** `integer` *required*
>
> User ID whose location, department, and role assignments to return.
>
> **company\_id** `integer` *required*
>
> Company ID that owns the user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **modified\_since** `string`
>
> Return only companies modified on or after this date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum departments to return in this page (1-200).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **company\_id** `integer` *required*
>
> Company ID whose departments to return.
>
> **location\_id** `integer`
>
> Return departments belonging to this location.
>
> **modified\_since** `string`
>
> Return only departments modified on or after this date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum locations to return in this page (1-500).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **deleted** `boolean`
>
> Whether to return deleted locations instead of active locations.
>
> **company\_id** `integer` *required*
>
> Company ID whose locations to return.
>
> **modified\_since** `string`
>
> Return only locations modified on or after this date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **open** `boolean`
>
> Filter by whether shifts are open for workers to request.
>
> **draft** `boolean`
>
> Return only unpublished draft shifts; overrides the deleted filter.
>
> **limit** `integer`
>
> Maximum shifts in this page (1-500).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **deleted** `boolean`
>
> Return published shifts that were deleted; cannot be combined with draft.
>
> **end\_gte** `string`
>
> Return shifts ending on or after this ISO 8601 date-time.
>
> **end\_lte** `string`
>
> Return shifts ending on or before this ISO 8601 date-time.
>
> **role\_id** `integer`
>
> Return shifts assigned to this role.
>
> **sort\_by** `string ("start" | "end")`
>
> Sort shifts by start or end time.
>
> **user\_id** `integer`
>
> Return shifts assigned to this user.
>
> **sort\_dir** `string ("asc" | "desc")`
>
> Sort direction.
>
> **shift\_ids** `array`
>
> Return only these shift IDs. Sent as one comma-separated query value.
>
> **start\_gte** `string`
>
> Return shifts starting on or after this ISO 8601 date-time.
>
> **start\_lte** `string`
>
> Return shifts starting on or before this ISO 8601 date-time.
>
> **company\_id** `integer` *required*
>
> Company ID whose shifts to return.
>
> **location\_id** `integer`
>
> Return shifts at this location.
>
> **department\_id** `integer`
>
> Return shifts in this department.
>
> **include\_draft** `boolean`
>
> Include draft shifts with published shifts; overrides the deleted and draft filters.
>
> **department\_ids** `array`
>
> Return shifts in any of these departments.
>
> **modified\_since** `string`
>
> Return only shifts modified on or after this ISO 8601 date-time.
>
> **include\_deleted** `boolean`
>
> Include deleted shifts with other matching shifts.
>
> **consider\_tz\_in\_ranges** `boolean`
>
> Honor offsets in supplied start/end range date-times instead of treating them as local location time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> Filter by a partial or full employee name.
>
> **limit** `integer`
>
> Maximum users to return in this page (1-500).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **status** `string ("active" | "inactive")`
>
> Return only active or inactive users.
>
> **role\_id** `integer`
>
> Return users assigned to this role; do not combine with location\_id or department\_id.
>
> **sort\_by** `string`
>
> Provider-supported field and direction used to sort the page.
>
> **company\_id** `integer` *required*
>
> Company ID whose users to return.
>
> **location\_id** `integer`
>
> Return users assigned to this location; do not combine with department\_id or role\_id.
>
> **department\_id** `integer`
>
> Return users assigned to this department; do not combine with location\_id or role\_id.
>
> **modified\_since** `string`
>
> Return only users modified on or after this date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Department
>
> **Slug:** `7SHIFTS_UPDATE_DEPARTMENT`
>
> Replace a department's name and default setting.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Complete replacement name for the department.
>
> **default** `boolean` *required*
>
> Complete replacement for whether this is the location's default department.
>
> **company\_id** `integer` *required*
>
> Company ID that owns the department.
>
> **department\_id** `integer` *required*
>
> Department ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
