Skip to main content
7shifts logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: 7SHIFTS
  • Version: 00000000_00

Tools

Slug: 7SHIFTS_CREATE_DEPARTMENTCreate a department at a company location, optionally make it the location’s default department, and return its new department ID.

Input Parameters

string
required
Department name, up to 155 characters. Use a unique name for temporary fixtures.
boolean
required
Whether this department becomes the location’s default department. Use false for isolated test fixtures.
integer
required
Company ID in which to create the department.
integer
required
Location ID that will own the department.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_DELETE_DEPARTMENTPermanently delete a department, optionally transferring its roles and shifts to another department.

Input Parameters

integer
required
Company ID that owns the department.
integer
Destination department ID for roles and shifts currently assigned to the deleted department; omit for an unused temporary department.
integer
required
Department ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_GET_DEPARTMENTReturn one department by company and department ID.

Input Parameters

integer
required
Company ID that owns the department.
integer
required
Department ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_GET_USER_ASSIGNMENTSReturn one user’s assigned locations, departments, and roles in a single read.

Input Parameters

integer
required
User ID whose location, department, and role assignments to return.
integer
required
Company ID that owns the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_LIST_COMPANIESReturn companies available to the connected access token, including the company IDs needed by company-scoped tools.

Input Parameters

string
Return only companies modified on or after this date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_LIST_DEPARTMENTSList one page of departments in a company, optionally filtered by location or modification date, with a cursor when more are available.

Input Parameters

integer
Maximum departments to return in this page (1-200).
string
Opaque next_cursor from a previous response; omit for the first page.
integer
required
Company ID whose departments to return.
integer
Return departments belonging to this location.
string
Return only departments modified on or after this date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_LIST_LOCATIONSList 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

integer
Maximum locations to return in this page (1-500).
string
Opaque next_cursor from a previous response; omit for the first page.
boolean
Whether to return deleted locations instead of active locations.
integer
required
Company ID whose locations to return.
string
Return only locations modified on or after this date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_LIST_SHIFTSList 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

boolean
Filter by whether shifts are open for workers to request.
boolean
Return only unpublished draft shifts; overrides the deleted filter.
integer
Maximum shifts in this page (1-500).
string
Opaque next_cursor from a previous response; omit for the first page.
boolean
Return published shifts that were deleted; cannot be combined with draft.
string
Return shifts ending on or after this ISO 8601 date-time.
string
Return shifts ending on or before this ISO 8601 date-time.
integer
Return shifts assigned to this role.
string ("start" | "end")
Sort shifts by start or end time.
integer
Return shifts assigned to this user.
string ("asc" | "desc")
Sort direction.
array
Return only these shift IDs. Sent as one comma-separated query value.
string
Return shifts starting on or after this ISO 8601 date-time.
string
Return shifts starting on or before this ISO 8601 date-time.
integer
required
Company ID whose shifts to return.
integer
Return shifts at this location.
integer
Return shifts in this department.
boolean
Include draft shifts with published shifts; overrides the deleted and draft filters.
array
Return shifts in any of these departments.
string
Return only shifts modified on or after this ISO 8601 date-time.
boolean
Include deleted shifts with other matching shifts.
boolean
Honor offsets in supplied start/end range date-times instead of treating them as local location time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_LIST_USERSList 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 7SHIFTS_UPDATE_DEPARTMENTReplace a department’s name and default setting.

Input Parameters

string
required
Complete replacement name for the department.
boolean
required
Complete replacement for whether this is the location’s default department.
integer
required
Company ID that owns the department.
integer
required
Department ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not