Plan Requirements

Access to 7shifts API is restricted to certain plans. This guide will describe the requirements for Partners accessing different resources outlined in the developer portal.

OAuth Clients Minimum Plan Requirements

When trying to integrate with 7shifts companies via the OAuth Client Company Grant process, a minimum plan check will be conducted based on the data access needs of your integration. The plan check is based on the feature list outlined in our pricing page. During your integration onboarding, we will assess the endpoints you are accessing to complete your integration, and based on the assessment, you will be provided a minimum plan a company must be on in order to successfully integrate with your product.

If a company does not meet the minimum plan required for your integration, they will be prompted about the plan restriction and presented options to upgrade their plan accordingly.

Please reference the detailed breakdown below of the plans required by integration type and endpoint.

Endpoint Access Minimum Plan Requirements

When accessing an endpoint via OAuth Client, a minimum plan check will be conducted to ensure that the company has the minimum plan required. If the plan requirement check fails, you will receive a 403 Forbidden response status code.

Plan Feature List

OAuth Client Category
 
Comp
Entrée
The Works
Gourmet
POS Sales
 
POS Sales + Labor
 
POS Sales + Labor + Schedule Enforcement
 
All Other Categories
 

Endpoints
 
Comp
Entrée
The Works
Gourmet
company
 
locations
 
departments
 
receipts
 
roles
 
users
 
user assignments
 
user wages
 
time punches
 
shifts
 
scheduled shifts
 
events
 
availability
 
time off
 
weekly report
 
worked hours & wages
 
daily summary
 
custom sales projections
 
OAuth client webhooks
 

Did this page help you?