For AI agents: visit https://developers.7shifts.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Guides
API Reference
Changelog
Discussions
2023-04-01
2023-05-01
2025-03-01
2026-01-01
Back to 7shifts.com
Become a Partner
API Reference
Back to 7shifts.com
Become a Partner
2026-01-01
Guides
API Reference
Changelog
Discussions
Authentication
JUMP TO
API Usage
Introduction
Authentication
Errors
Versioning
Pagination
API Status & Support
Postman Collection
7shifts API
Authentication
Create OAuth Token
post
Retrieve Identity
get
Account
Create Trial Account
post
Companies
List Companies
get
Retrieve Company
get
Update Company
patch
Retrieve Labor Settings
get
List Inactive Reasons
get
Locations
List Locations
get
Create Location
post
Retrieve Location
get
Update Location
put
Delete Location
del
Departments
List Departments
get
Create Department
post
Retrieve Department
get
Update Department
put
Delete Department
del
Roles
List Roles
get
Create Role
post
Retrieve Role
get
Update Role
put
Delete Role
del
Users
List Users
get
Create User
post
Create Many Users
post
Retrieve User
get
Update User
put
Deactivate User
del
List User Authorized Locations
get
List User Contacts
get
Retrieve User Contact
get
User Wages
List User Wages
get
Create User Wage
post
User Assignments
List Assignments
get
List Location Assignments
get
Create Location Assignments
post
Delete Location Assignment
del
List Department Assignments
get
Create Department Assignment
post
Delete Department Assignment
del
List Role Assignments
get
Create Role Assignment
post
Delete Role Assignment
del
Update Role Assignment
put
Create Many Role Assignments
post
Employment Record
List Employment Record
get
Create Employment Record
post
Create Many Employment Records
post
Update Employment Record
put
Delete Employment Record
del
Shifts
List Shifts
get
Create Shift
post
Retrieve Shift
get
Update Shift
put
Delete Shift
del
Schedule Enforcement
List Scheduled Shifts
get
Time Punches
List Time Punches
get
Create Time Punch
post
Retrieve Time Punch
get
Update Time Punch
put
Delete Time Punch
del
Time Clocking
List Payroll Periods
get
Retrieve Payroll Period
get
Receipts
List Receipts
get
Create Receipt
post
Retrieve Receipt
get
Update Receipt
put
Retrieve Receipts Summary
get
External User Mappings
Retrieve User External Mapping
get
Update External User Mappings
put
Delete External User Mapping
del
List External User Mapping
get
Create External User Mapping
post
Create User External Mappings
post
List External User Mapping
get
Create External User Mapping
post
Create User External Mappings
post
Retrieve User External Mapping
get
Update External User Mapping
put
Delete External User Mapping
del
Schedule Events
List Events
get
Create Event
post
Retrieve Event
get
Update Event
patch
Delete Event
del
Log Book
List Log Book Categories
get
Create Log Book Category
post
Delete Log Book Category
del
Update Log Book Category
patch
List Log Book Posts
get
Create Log Book Post
post
Retrieve Log Book Post
get
Delete Log Book Post
del
List Log Book Comments
get
Create Log Book Comment
post
Retrieve Log Book Comment
get
Delete Log Book Comment
del
Task Management
Retrieve Task Management Settings
get
Create Task Tags
post
Delete Task Tags
del
List Task List Templates
get
Create Task List Template
post
Retrieve Task List Template
get
Delete Task List Template
del
Update Task List Template
put
List Task Lists
get
Retrieve Task List
get
Clear Task
post
Complete Task
post
List Task List Daily Summary
get
Reports
Retrieve Worked Hours and Wages
get
Retrieve Daily Sales and Labor
get
Retrieve Daily Stats
get
Forecast Overrides
Create Daily Projected Forecast Override
post
Create Bulk Forecast Override Intervals
post
Delete Sales Forecast Override Interval
del
Create Sales Forecast Override Interval
post
Create Daily Projected Forecast Overrides
post
Sync Daily Projected Forecast Override
del
Create Daily Projected Forecast Overrides
post
Tip Pool
Retrieve Tip Pool Settings
get
Retrieve Tip Pool Manual Entries
get
Update Tip Pool Manual Entries
put
Retrieve Tip Pool Summary Report
get
Retrieve Tip Pool Detailed Report
get
Day Part
Retrieve Day Part Settings
get
Availability
List Availabilities
get
Create Availability
post
Retrieve Availability
get
Update Availability
put
Delete Availability
del
Update Availability Status
put
List Availability Reasons
get
Create Availability Reason
post
Update Availability Reason
put
Delete Availability Reason
del
Time Off
List Time Off
get
Create Time Off
post
Retrieve Time Off
get
Delete Time Off
del
Update Time Off
patch
Approve Time Off Request
post
Decline Time Off Request
post
Retrieve Time Off Hours
get
Retrieve Time Off Settings
get
Create Time Off Settings
post
Shift Feedback
List Shift Feedback
get
Engage
Retrieve Engagement Overview
get
Webhooks
List Webhooks
get
Create Webhook
post
Update Webhook
put
Delete Webhook
del
Test Webhook Notification
get
Webhooks
Introduction
Configure Company Level Webhooks
payroll_period.closed
schedule.published
time_punch.created
time_punch.edited
time_punch.deleted
user.created
user.modified
user.deactivated
user.reactivated
department.created
department.modified
department.deleted
location.created
location.modified
location.deleted
role.created
role.modified
role.deleted
authorization.revoked
Powered by
Authentication
Copy Page
Updated about 1 year ago
Introduction
Errors
Did this page help you?
Yes
No
Updated about 1 year ago
Introduction
Errors
Did this page help you?
Yes
No
Access Tokens
Creating Access Tokens
Using Access Tokens
Editing Access Tokens
Deleting Access Tokens
OAuth Clients
