Jump to Content

API Reference

Getting Started

Staffjoy Suite API Basics
Authentication

Base

Current Session and Accessget

Users

All Usersget
Create Userpost
Userget
Modify a Userpatch

Sessions

All Sessionsget
Delete All Sessionsdelete
Sessionget
Delete a Sessiondelete

API Keys

All API Keysget
Create an API Keypost
API Keyget
Delete an API Keydelete

Organizations

All Organizationsget
Create Organizationpost
Organizationget
Modify an Organizationpatch

Organization Admins

All Organization Adminsget
Create Organization Adminpost
Adminget
Modify an Adminpatch
Delete an Admindelete

Organization Workers

All Organization Workersget

Locations

All Locationsget
Create Locationpost
Locationget
Modify a Locationpatch
Delete Locationdelete

Location Related Data

Location Shiftsget
Location Timeclocksget
Location Time Off Requestsget

Location Managers

All Managersget
Create a Managerpost
Managerget
Modify a Managerpatch
Delete a Managerdelete

Attendance

Location Attendanceget

Roles

All Rolesget
Create Rolepost
Roleget
Modify a Rolepatch
Delete Roledelete

Role Workers

All Role Workersget
Create a Role Workerpost
Role Workerget
Modify a Role Workerpatch
Delete a Role Workerdelete

Schedules

Schedule Overview
Schedule State Machine
All Schedulesget
Scheduleget
Modify a Schedulepatch

Schedule Related Data

Schedule Shiftsget
Schedule Timeclocksget
Schedule Time Off Requestsget

Worker Preferences

All Preferencesget
Create Preferencespost
Preferencesget
Modify Preferencespatch
Delete Preferencesdelete

Shifts

Shifts Overview
All Shiftsget
Create a Shiftpost
Shiftget
Modify a Shiftpatch
Delete a Shiftdelete

Shift Users

Shift Eligible Usersget

Recurring Shifts

All Recurring Shiftsget
Create a Recurring Shiftpost
Recurring Shiftget
Modify a Recurring Shiftpatch
Delete a Recurring Shiftdelete

Timeclocks

Timeclocks Overview
All Timeclocksget
Create a Timeclockpost
Timeclockget
Modify a Timeclockpatch
Delete a Timeclockdelete

Time Off Requests

Time Off Requests Overview
All Time Off Requestsget
Create a Time Off Requestpost
Time Off Requestget
Modify a Time Off Requestpatch
Delete a Time Off Requestdelete

Timezones

All Timezonesget

Powered by

Create an API Key

post https://example.com/users/{user_id}/apikeys/

📘
Permission Required: Self

Language

Click Try It! to start a request and see the response here!