Jump to Content
API Reference
v1
v2
API Reference
v2
API Reference
All API Keys
Search
JUMP TO
Getting Started
Staffjoy Suite API Basics
Authentication
Base
Current Session and Access
get
Users
All Users
get
Create User
post
User
get
Modify a User
patch
Sessions
All Sessions
get
Delete All Sessions
delete
Session
get
Delete a Session
delete
API Keys
All API Keys
get
Create an API Key
post
API Key
get
Delete an API Key
delete
Organizations
All Organizations
get
Create Organization
post
Organization
get
Modify an Organization
patch
Organization Admins
All Organization Admins
get
Create Organization Admin
post
Admin
get
Modify an Admin
patch
Delete an Admin
delete
Organization Workers
All Organization Workers
get
Locations
All Locations
get
Create Location
post
Location
get
Modify a Location
patch
Delete Location
delete
Location Related Data
Location Shifts
get
Location Timeclocks
get
Location Time Off Requests
get
Location Managers
All Managers
get
Create a Manager
post
Manager
get
Modify a Manager
patch
Delete a Manager
delete
Attendance
Location Attendance
get
Roles
All Roles
get
Create Role
post
Role
get
Modify a Role
patch
Delete Role
delete
Role Workers
All Role Workers
get
Create a Role Worker
post
Role Worker
get
Modify a Role Worker
patch
Delete a Role Worker
delete
Schedules
Schedule Overview
Schedule State Machine
All Schedules
get
Schedule
get
Modify a Schedule
patch
Schedule Related Data
Schedule Shifts
get
Schedule Timeclocks
get
Schedule Time Off Requests
get
Worker Preferences
All Preferences
get
Create Preferences
post
Preferences
get
Modify Preferences
patch
Delete Preferences
delete
Shifts
Shifts Overview
All Shifts
get
Create a Shift
post
Shift
get
Modify a Shift
patch
Delete a Shift
delete
Shift Users
Shift Eligible Users
get
Recurring Shifts
All Recurring Shifts
get
Create a Recurring Shift
post
Recurring Shift
get
Modify a Recurring Shift
patch
Delete a Recurring Shift
delete
Timeclocks
Timeclocks Overview
All Timeclocks
get
Create a Timeclock
post
Timeclock
get
Modify a Timeclock
patch
Delete a Timeclock
delete
Time Off Requests
Time Off Requests Overview
All Time Off Requests
get
Create a Time Off Request
post
Time Off Request
get
Modify a Time Off Request
patch
Delete a Time Off Request
delete
Timezones
All Timezones
get
Powered byÂ
All API Keys
get
https://example.com/users/
{user_id}
/apikeys/
📘
Permission Required: Self
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!