7shifts Tools

Deactivate a user account. CAUTION: This will deactivate the user's account and they will lose access to the system. Historical data will be preserved...

Permanently delete an availability window. CAUTION: This action cannot be undone. The availability will be removed and may affect scheduling. Use this...

Permanently delete an availability reason. CAUTION: This action cannot be undone. The reason will be removed from the system and may affect existing a...

Permanently delete a department. CAUTION: This action cannot be undone. The department will be removed and may affect shifts, assignments, and histori...

Remove a user's department assignment. CAUTION: This will remove the user's access to this department and may affect their ability to work shifts in t...

Delete an event. Use this to remove events from the schedule. For recurring events, use recurrence_target and start_date to control which occurrences ...

Delete a forecast override for a specific location and date. CAUTION: This action cannot be undone. The forecast will revert to automatic calculations...

Permanently delete a location. CAUTION: This action cannot be undone. The location will be removed and may affect shifts, employees, schedules, and hi...

Remove a user's location assignment. CAUTION: This will remove the user's access to this location and may affect their ability to work shifts at that ...

Permanently delete a log book category. CAUTION: This action cannot be undone. The category will be removed and may affect existing log entries that r...

Permanently delete a log book comment. CAUTION: This action cannot be undone. The comment will be removed from the log book post.

Permanently delete a log book post. CAUTION: This action cannot be undone. The log entry will be removed from the log book. Use this to remove incorre...

Permanently delete a role. CAUTION: This action cannot be undone. The role will be removed and may affect shifts, assignments, and historical data. Us...

Remove a user's role assignment. CAUTION: This will remove the user's access to this role and may affect their ability to work shifts requiring this r...

Permanently delete a shift. CAUTION: This action cannot be undone. The shift will be removed from schedules and employees will be notified if the shif...

Permanently delete a task list template. CAUTION: This action cannot be undone. The template will be removed and may affect existing task lists create...

Permanently delete task tags. CAUTION: This action cannot be undone. The tags will be removed and may affect tasks that reference them.

Permanently delete a time off request. CAUTION: This action cannot be undone. The time off request will be removed and may affect employee leave balan...

Permanently delete a time punch. CAUTION: This action cannot be undone. The time punch will be removed and may affect payroll calculations and hours w...

Permanently delete a webhook. CAUTION: This action cannot be undone. The webhook will stop receiving event notifications immediately. Use this to remo...

Access detailed information about a user's assignments within a specified company using company_id and user_id. Ideal for reviewing employee roles and...

Obtain department assignment details for a user within a company by providing company_id and user_id. Useful for managing and tracking an employee's d...

Access department information for a specific company using the company_id. Use this to structure staff and operations effectively across departments. ...

Retrieve details for a specific event. Use this to get comprehensive information about a single event including all associated data and metadata.

Retrieve location assignments for a user by specifying the company_id and user_id. Use this to determine which locations an employee is associated wit...

Fetch role assignments of a user in a specific company by using company_id and user_id. Perfect for understanding employee roles and responsibilities....

Fetch detailed employee time punches for a specific restaurant using a company_id. Use this to track your staff's clock-in and clock-out times for att...

Retrieve detailed information for a specific company by its ID. Use this to get comprehensive company details including name, status, settings, and co...

Retrieve engagement overview for a location. Engagement overview provides insights into employee engagement metrics including lates, no-shows, sick sh...

Retrieve detailed information for a specific external user mapping by its identifier. Use this to get mapping details between external systems and 7sh...

Retrieve labor settings for a company. Labor settings configure overtime rules, break policies, and labor cost calculations. Returns comprehensive lab...

Retrieve detailed information for a specific log book category by its ID. Use this to get category configuration including field type, notification se...

Retrieve detailed information for a specific log book comment by its ID. Use this to get comment details including content, author, and timestamps. Re...

Retrieve detailed information for a specific log book entry by its ID. Use this to get comprehensive entry details including content, author, timestam...

Retrieve detailed information for a specific receipt by its ID. Use this to get comprehensive receipt details including amount, date, category, notes,...

Retrieve a summary of receipts for a company. Use this to get aggregated receipt data including totals, counts, and summary statistics. Supports filte...

Retrieve detailed information for a specific scheduled shift by its ID. Use this to get scheduled shift details including assigned employee, location,...

Retrieve detailed information for a specific shift by its ID. Use this to get comprehensive shift details including assigned employee, location, depar...

Retrieve task management settings for a company. Task management settings configure how tasks are managed, including auto-assignment rules, reminders,...

Check for scheduling conflicts with a specific time off request. Use this to identify overlapping shifts, other time off requests, or scheduling issue...

Retrieve detailed information for a specific time off request by its ID. Use this to get comprehensive request details including dates, reason, status...

Generate a detailed tip pool report for a location. Use this to get comprehensive tip distribution analysis with transaction-level details. Supports f...

Retrieve tip pool settings for a company. Tip pool settings configure how tips are distributed among employees. Returns tip pool configuration includi...

Generate a summary tip pool report for a location. Use this to analyze tip distribution, tip pool performance, and tip allocation metrics. Supports fi...

Retrieve detailed information for a specific user by their ID. Use this to get comprehensive user details including name, email, roles, assignments, a...

Retrieve employee availability windows for a company. Use this to see when employees are available to work, which is essential for creating schedules ...

Retrieve a list of all the companies within your 7shifts account. Use this to review or manage organizational settings across multiple business locati...

Retrieve a list of day parts configured for a company. Day parts are time periods used to organize shifts (e.g., Breakfast, Lunch, Dinner, Late Night)...

Retrieve a list of employment records for a company. Use this to review employee employment history, track employment status, and access HR data. Supp...

Retrieve a list of events for a company. Events include schedule-related activities, shift changes, and other company events. Supports filtering by lo...

Retrieve a list of inactive reasons configured for a company. Inactive reasons are used to categorize why employees become inactive (e.g., 'quit', 'te...

Obtain a list of locations for a specific company by providing the company_id. Ideal for managing site-specific operations and scheduling. Returns dat...

Retrieve a list of log book categories configured for a company. Use this to see available category types for organizing log entries. Returns category...

Retrieve a list of log book entries for a company. Use this to review shift notes, operational logs, and communication entries. Supports filtering by ...

Retrieve a list of expense receipts for a company. Use this to track employee expenses, review receipt submissions, and manage expense reimbursements....

Fetch a list of roles available in a specified company by using the company_id. Useful for assigning or managing staff positions. Returns role IDs and...

Retrieve a list of shift feedback entries for a company. Use this to review employee feedback about shifts, gather insights about shift experiences, a...

Retrieve a comprehensive list of all scheduled shifts for a restaurant by specifying the company_id. It's ideal for reviewing and managing employee sh...

Retrieve a list of tasks for a company. Use this to track operational tasks, shift-specific duties, and task assignments. Supports filtering by locati...

Retrieve a list of time off policies configured for a company. Use this to understand available leave types, accrual rules, and policy details. Return...

Retrieve a list of time off requests for a company. Use this to review pending approvals, track employee absences, and manage leave requests. Supports...

Retrieve all users associated with a specific company by providing the company_id. Ideal for monitoring and updating employee details. Returns user in...

Get wage details for a user within a specific company by using both company_id and user_id. Useful for payroll and budgeting tasks. Returns wage rates...

Retrieve a list of webhooks configured for a company. Webhooks enable real-time notifications for events like shift changes, time punches, and user up...

Search across 7shifts resources using natural language queries. Use this to find shifts, users, locations, time off requests, receipts, tasks, and oth...

Create or update employee availability windows. Use this to set when employees are available to work, which helps create schedules that match employee...

Create a new day part or update an existing one. Day parts organize shifts by time periods (e.g., Breakfast, Lunch, Dinner). Use this to configure ope...

Create or update an event. Events represent schedule-related activities, meetings, training sessions, and other company events. For create: requires t...

Create or update a forecast override. Forecast overrides allow manual adjustment of labor and sales forecasts. Use this to account for special events,...

Create a new log book entry or update an existing one. Use this to record shift notes, incidents, training records, and operational communications. Fo...

Create a new expense receipt or update an existing one. Use this to submit employee expenses for reimbursement or update receipt details. For create: ...

Create a new shift or update an existing one. Use this to schedule employees, assign shifts to locations/departments/roles, and manage shift details. ...

Create or update shift feedback. Use this to collect employee feedback about shifts, gather insights about shift experiences, and track feedback over ...

Create a new task or update an existing one. Use this to assign operational tasks to employees, track task completion, and manage shift-specific dutie...

Create a new time off request or update an existing one. Use this to submit employee leave requests or modify pending requests. For create: requires u...

Create or update a webhook. Webhooks enable real-time notifications for 7shifts events. Use this to configure webhooks that receive notifications for ...