7Shifts API Directory

7Shifts is a robust employee scheduling software tailored specifically for the restaurant industry, offering a suite of tools that streamline workforce management. By focusing on the unique needs of restaurant operations, 7Shifts provides features such as scheduling, time tracking, tip management, payroll integration, and team communication. These functionalities are designed to enhance operational efficiency, reduce labor costs, and improve staff productivity, making it an essential tool for restaurant managers looking to optimize their workforce management processes.

One of the standout features of 7Shifts is its ability to integrate seamlessly with various platforms through the 7Shifts API. This integration capability allows restaurants to connect their existing systems with 7Shifts, ensuring a smooth flow of data and enhancing overall operational efficiency. The 7Shifts API enables businesses to customize their scheduling and workforce management processes, providing a flexible solution that adapts to the specific needs of each restaurant. As such, understanding the 7Shifts API integration process is crucial for maximizing the software's potential and achieving optimal results in restaurant management.

Key highlights of 7Shifts APIs

Easy Data Access:
- Organized around predictable, resource-oriented URLs for easier data management.
Automation:
- Supports automation through integration with other systems.
Custom Integration:
- Integrates with key POS, time clocking, and payroll software for enhanced management processes.
Real-Time Sync:
- Supports webhooks for real-time data synchronization and event-driven actions.
Strong Security:
- Uses HTTP response codes for secure communication.
Scalable:
- Handles multiple requests with rate limiting at 10 requests per second per access token.
Developer-Friendly:
- Follows RESTful principles with predictable URLs.
Error Handling and Logging:
- Utilizes HTTP response codes for effective error handling.
Rate Limiting:
- Enforces rate limits to ensure fair usage.
Webhook Support:
- Enables real-time data synchronization and event-driven actions.

7Shifts API Endpoints

Authentication

POST https://api.7shifts.com/oauth2/token : Acquire OAuth Token

Company

GET https://api.7shifts.com/v2/companies/{id} : Get Company Details
POST https://api.7shifts.com/v2/company/{company_id}/create_many_users : Create Multiple Users in a Company
GET https://api.7shifts.com/v2/company/{company_id}/departments : Get Company Departments
PUT https://api.7shifts.com/v2/company/{company_id}/departments/{department_id} : Update Department Details
GET https://api.7shifts.com/v2/company/{company_id}/events : Get Company Events
DELETE https://api.7shifts.com/v2/company/{company_id}/events/{event_id} : Delete Event from Company
GET https://api.7shifts.com/v2/company/{company_id}/external_user_mappings : Get External User Mappings for a Company
PUT https://api.7shifts.com/v2/company/{company_id}/external_user_mappings/{identifier} : Update External User Mappings
POST https://api.7shifts.com/v2/company/{company_id}/external_user_mappings_bulk : Bulk External User Mappings for a Company
GET https://api.7shifts.com/v2/company/{company_id}/inactive_reasons : Get Inactive Reasons for a Company
GET https://api.7shifts.com/v2/company/{company_id}/labor_settings : Get Company Labor Settings
GET https://api.7shifts.com/v2/company/{company_id}/roles : Get Company Roles
GET https://api.7shifts.com/v2/company/{company_id}/roles/{role_id} : Get Role Details for a Company
GET https://api.7shifts.com/v2/company/{company_id}/shift_feedback : Get Shift Feedback for a Company
GET https://api.7shifts.com/v2/company/{company_id}/task_management_settings : Get Task Management Settings for a Company
POST https://api.7shifts.com/v2/company/{company_id}/task_tags : Create Task Tags for a Company
GET https://api.7shifts.com/v2/company/{company_id}/test_webhook : Test Webhook for a Company
GET https://api.7shifts.com/v2/company/{company_id}/webhooks : Get Company Webhooks
DELETE https://api.7shifts.com/v2/company/{company_id}/webhooks/{webhook_id} : Delete Webhook for a Company
POST https://api.7shifts.com/v2/partner_company_creation : Create Trial Company

Locations

GET https://api.7shifts.com/api/v2/company/{company_id}/location/{location_id}/daily_stats : Get Daily Statistics for a Company Location
POST https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/forecast_override : Create Forecast Override for a Location
GET https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings : Get Sales Category Mappings for a Location
DELETE https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings/{external_id} : Delete Sales Category Mapping
POST https://api.7shifts.com/v2/company/{company_id}/location/{location_id}/sales_category_mappings_bulk : Bulk Sales Category Mappings for a Location
GET https://api.7shifts.com/v2/company/{company_id}/locations : Get Company Locations
DELETE https://api.7shifts.com/v2/company/{company_id}/locations/{location_id} : Delete Location from Company
GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/engage_overview : Get Engage Overview for a Location
POST https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/forecast_override_interval : Override Project Sales Interval
POST https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/forecast_overrides_intervals : Override Project Sales Intervals
GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/tip_pool_detailed_report : Get Tip Pool Detailed Report
GET https://api.7shifts.com/v2/company/{company_id}/locations/{location_id}/tip_pool_summary_report : Get Tip Pool Summary Report

Availabilities

POST https://api.7shifts.com/v2/company/{company_id}/availabilities : Create Company Availability
PUT https://api.7shifts.com/v2/company/{company_id}/availabilities/{availability_id} : Update Availability for a Company
PUT https://api.7shifts.com/v2/company/{company_id}/availabilities/{availability_id}/status : Update Availability Status
GET https://api.7shifts.com/v2/company/{company_id}/availability_reasons : Get Availability Reasons for a Company
PUT https://api.7shifts.com/v2/company/{company_id}/availability_reasons/{availability_reason_id} : Update Availability Reason for a Company

Log Book

GET https://api.7shifts.com/v2/company/{company_id}/log_book_categories : Get Log Book Categories for a Company
PATCH https://api.7shifts.com/v2/company/{company_id}/log_book_categories/{id} : Update Log Book Category
POST https://api.7shifts.com/v2/company/{company_id}/log_book_comments : Create Log Book Comment
GET https://api.7shifts.com/v2/company/{company_id}/log_book_comments/{id} : Get Log Book Comment Details
GET https://api.7shifts.com/v2/company/{company_id}/log_book_posts : Get Log Book Posts for a Company
DELETE https://api.7shifts.com/v2/company/{company_id}/log_book_posts/{id} : Delete Log Book Post

Receipts

POST https://api.7shifts.com/v2/company/{company_id}/receipts : Create Company Receipt
PUT https://api.7shifts.com/v2/company/{company_id}/receipts/{receipt_id} : Update Receipt Details
GET https://api.7shifts.com/v2/company/{company_id}/receipts_summary : Get Receipts Summary for a Company

Shifts

POST https://api.7shifts.com/v2/company/{company_id}/shifts : Create a Shift for a Company
GET https://api.7shifts.com/v2/company/{company_id}/shifts/{shift_id} : Get Shift Details
GET https://api.7shifts.com/v2/company/{company_id}/shifts_scheduled/{id} : Get Scheduled Shift Details

Task Lists

GET https://api.7shifts.com/v2/company/{company_id}/task_list_daily_summary : Get Task List Daily Summary
POST https://api.7shifts.com/v2/company/{company_id}/task_list_templates : Create Task List Template
PUT https://api.7shifts.com/v2/company/{company_id}/task_list_templates/{uuid} : Update Task List Template
GET https://api.7shifts.com/v2/company/{company_id}/task_lists : Get Task Lists for a Company
GET https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id} : Get Task List Details
POST https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/clear : Clear a Task in a Task List for a Company
POST https://api.7shifts.com/v2/company/{company_id}/task_lists/{list_id}/tasks/{task_id}/complete : Complete a Task in a Task List for a Company

Time Punches

POST https://api.7shifts.com/v2/company/{company_id}/time_punches : Create Time Punch for a Company
GET https://api.7shifts.com/v2/company/{company_id}/time_punches/{time_punch_id} : Get Time Punch Details

Tip Pool

PUT https://api.7shifts.com/v2/company/{company_id}/tip_pool/{tip_pool_settings_uuid}/manual_entry : Update Manual Entry for Tip Pool
GET https://api.7shifts.com/v2/company/{company_id}/tip_pool_settings : Get Tip Pool Settings for a Company

Users

POST https://api.7shifts.com/v2/company/{company_id}/users : Create a New User in a Company
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{identifier} : Delete User from Company
GET https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/assignments : Get User Assignments in a Company
POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/department_assignments : Create Department Assignment for User
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/department_assignments/{department_id} : Delete User Department Assignment
GET https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/location_assignments : Get User Location Assignments
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/location_assignments/{location_id} : Delete User Location Assignment
POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/role_assignments : Assign Role to User in Company
DELETE https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/role_assignments/{role_id} : Delete Role Assignment for a User in a Company
POST https://api.7shifts.com/v2/company/{company_id}/users/{user_id}/wages : Create User Wage

Reports

GET https://api.7shifts.com/v2/reports/daily_sales_and_labor : Get Daily Sales and Labor Report
GET https://api.7shifts.com/v2/reports/hours_and_wages : Get Hours and Wages Report

Time Off

GET https://api.7shifts.com/v2/time_off : Get Time Off Details
GET https://api.7shifts.com/v2/time_off/total_hours : Get Total Time Off Hours
PATCH https://api.7shifts.com/v2/time_off/{time_off_id} : Update Time Off Request
POST https://api.7shifts.com/v2/time_off/{time_off_id}/approve : Approve Time Off Request
POST https://api.7shifts.com/v2/time_off/{time_off_id}/decline : Decline Time Off Request
POST https://api.7shifts.com/v2/time_off_settings/{company_id} : Set Time Off Settings for a Company

User Identity

GET https://api.7shifts.com/v2/whoami : Get User Identity and Details

‍

7Shifts API FAQs

‍

1. How do I authenticate my API requests to 7Shifts?

7Shifts uses OAuth 2.0 for authentication. You'll need to obtain a client ID and client secret from 7Shifts to generate access tokens.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/authentication

2. What are the rate limits for the 7Shifts API?

7Shifts has rate limits in place to prevent abuse. Refer to the official documentation for the specific rate limits and potential throttling mechanisms.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/introduction

3. How can I create a new employee in 7Shifts using the API?

You can use the POST /users endpoint to create new employees. Refer to the API documentation for the required parameters and request body format.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/users

4. Can I use webhooks with the 7Shifts API to receive real-time notifications?

Yes, 7Shifts supports webhooks for real-time notifications. You can configure webhooks to receive updates on various events, such as new shifts, time-off requests, and more.
Source: 7Shifts API Documentation: https://developers.7shifts.com/reference/webhooks

5. What are the best practices for error handling in 7Shifts API integrations?

Always check the HTTP status code of API responses to identify errors. 7Shifts API returns detailed error messages in the response body. Handle different error codes appropriately to ensure your integration is robust.
Source: 7Shifts API Documentation: https://developers.7shifts.com/

‍

Get Started with 7Shifts API Integration

For quick and seamless integration with 7Shifts API, Knit API offers a convenient solution. It’s AI powered unified integration platform allows you to build any 7Shifts API Integration use case. By integrating with Knit just once, you can integrate with multiple other ATS, HRIS, Payroll and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to 7Shifts API.

‍

To sign up for free, click here. To check the pricing, see our pricing page.