---
title: "Staffshift API Gateway"
account: staffshift
slug: staffshift-api-gateway
---

# Staffshift API Gateway

- Operations: 691
- Versions: 1 (latest `6e2cb83db3a9`)
- Source: https://api.staffshift.com/v1/api-docs
- OpenAPI document: https://skmtc-service-production.skmtc.workers.dev/v1/apis/staffshift/staffshift-api-gateway/revisions/6e2cb83db3a9/schema

## Operations

691 in total, by tag:

- Conversation Webhooks (1)
- Message Webhooks (2)
- Agency Group Candidate Misc (2)
- Agency Group Webhook Settings (1)
- Agency Group Webhook Subscription (1)
- Agency Group Webhook Subscription Notifications (1)
- Agency Group Webhook Topic (1)
- Candidate Equality Details (2)
- Timesheet (2)
- Agency Group Candidate Registration (1)
- Username Suggestion and availability (1)
- User Check Email (1)
- Candidate Availability (2)
- Agency Candidate Availability (2)
- Candidate Booked Shifts (1)
- User integrations (1)
- Agency Group Users (2)
- Agency Group Candidate (14)
- Acl Groups (7)
- Status (1)
- Agency Group Policy Action (1)
- Agency Group Policy Type (4)
- Languages (1)
- Processed Policy (2)
- Agency Group Policy (2)
- Policy (10)
- CandidatePlugin (4)
- User Plugins (4)
- CandidateInvitation (2)
- Candidate (12)
- Candidate Basic Info (2)
- Candidate Misc Details (2)
- AgencyCandidate (11)
- Candidate Email Verify (1)
- Candidate Next Of Kin (5)
- Agency Candidate Languages (5)
- Candidate Other Names (2)
- Agency Candidate Other Names (2)
- Agency Group Candidate OtherNames (2)
- Agency Candidate Contact Numbers (5)
- Agency Group Candidate Contact Numbers (5)
- Candidate Contact Numbers (5)
- Agency Candidate Type (1)
- Agency Group Candidate Type (1)
- Agency Candidate Address Details (6)
- Agency Group Candidate Address Details (6)
- Candidate Address Details (5)
- Staffshift Policy Type (4)
- Staffshift Policy (3)
- Staffshift Policy type version (2)
- Agency Group Registration Settings (3)
- Resource Policies (2)
- Candidate Email Details (4)
- Agency Candidate Email Details (4)
- Agency Group Candidate Email Details (4)
- Agency Group Status Reason (4)
- Agency Group status details (6)
- Agency Status Details (3)
- Agency Group Candidate Status (3)
- Agency Candidate Status (2)
- Agency Group Consultant Role (3)
- Agency Group Candidate Consultant (6)
- Agency Group Candidate Additional Note (2)
- Agency Candidate Additional Note (2)
- Agency Group Candidate Activity (2)
- Agency Group Candidate Meta (4)
- Agency Candidate Meta (1)
- Agency Group Candidate Status History (2)
- Agency Group Candidate Status Summary (1)
- Agency Candidate Status Summary (1)
- Candidate Settings (3)
- Agency Candidate Settings (1)
- Agency Group Candidate Settings (2)
- Agency Candidate Invitation Verification (1)
- Agency Group Candidate Invitation Verification (1)
- Agency Job Title (1)
- Agency Group Job Title (1)
- Job Family (2)
- Job Title (1)
- Agency Linked Clients (1)
- Candidate Documents (3)
- Agency Group Candidate Documents (4)
- Agency Candidate Documents (4)
- Agency Group Document Types (4)
- System Document Types (4)
- Candidate Document Types (1)
- Agency Candidate Document Types (1)
- Agency Group Candidate Document Types (1)
- Agency Group Candidate Activity Email (1)
- Agency Lookup (4)
- Agency Group Lookup (4)
- Agency Group Candidate Widgets (4)
- Candidate Widgets (1)
- Activity Type (2)
- Agency Group Notification Type (3)
- Agency Group Candidate Notification (2)
- Webhook Mailgun (1)
- Candidate Employment (5)
- Agency Candidate Employment (4)
- Agency Group Candidate Employment (4)
- Agency Group Candidate Reports (1)
- Agency Candidate Activity (2)
- System skills (4)
- System Job Family (2)
- System Job Title (2)
- System position types (3)
- Agency Candidate Activity Email (1)
- Candidate Skills (2)
- Agency Candidate Skills (2)
- Agency Group Candidate Skills (2)
- Agency Group Candidate Stated Skills (4)
- Candidate Stated Skills (3)
- Candidate Qualifications (5)
- Agency Candidate Qualifications (2)
- Agency Group Candidate Qualifications (6)
- System Qualifications (4)
- Firebase custom token (1)
- Agency Group Agency (1)
- Agency Agency Group (1)
- Agency Contact Numbers (4)
- System Registration Body Entries (5)
- Candidate Registration Body (5)
- Agency Candidate Registration Body (2)
- Agency Group Candidate Registration Body (5)
- System Registration Body (5)
- System Registration Body Entry Status (4)
- System Registration Body Status (4)
- Agency Group Candidate Registration Body Entry (1)
- Candidate Employment Dismissals (5)
- Agency Group Candidate Employment Dismissals (5)
- Agency Candidate Employment Dismissals (2)
- Chat (14)
- Candidate Conversation (2)
- Plugin Setting (2)
- System Activity Type (4)
- Agency Group Candidate Employment Position Held (1)
- Agency Candidate Employment Position Held (1)
- Agency ip whitelist all access user (3)
- Agency group ip whitelist all access user (3)
- Agency ip-whitelist (4)
- Agency group ip-whitelist (4)
- Agency Users (2)
- SocialLinkType (4)
- Agency Group Candidate Social Link (5)
- Agency Candidate Social Link (5)
- Candidate Social Link (5)
- Agency Candidate Activity Conversation (1)
- Agency Group Candidate Activity Conversation (1)
- User Avatar (4)
- Agency User Avatar (3)
- Agency Group User Avatar (3)
- Agency Organisation (1)
- Agency Contract (1)
- Agency User (1)
- Contract Link (2)
- Industry (1)
- Timezone Lookup (1)
- Agency Group Compliance Summary Settings (2)
- Agency Compliance Summary Settings (1)
- AgencyGroup (4)
- Webhooks (2)
- Agency Group Candidate Notifications (1)
- Agency Group Candidate Bulk Notification (1)
- Agency Candidate Notifications (1)
- Agency Candidate Bulk Notification (1)
- Conversation (5)
- Conversation Chatterbox Profiles (3)
- Teams (4)
- Candidate Notifications (2)
- Candidate Notification Settings (3)
- Candidate Notification Types (2)
- Context Candidate Notifications (2)
- Candidate Notification Send Preview (2)
- Context Notification (2)
- Agency Group Notification Type Templates (1)
- Context Notification Types (6)
- Context Notification Type Templates (10)
- Agency Notification Type Templates (1)
- Notification Groups (4)
- Notification Tokens (5)
- Notification Types (7)
- Lookup (1)
- Agency Group Candidate Position Held Status (1)
- Candidate Position Held Work History Breakdown (2)
- Agency Group Candidate Registration Body entry (2)
- Agency Candidate Position Held Status (1)
- Candidate Position Held Status (1)
- Candidate Employment Position Held (1)
- Agency Group Compliance Summary Basic (1)
- Agency Group Candidate Compliance Summary Expiry (1)
- Agency Group Candidate Compliance Summary Health (1)
- Agency Group Candidate Compilation Changes (1)
- Candidate Compliance Contract Rule Summary (2)
- Compliance Contract Rule Summary (2)
- Compliance Contract (6)
- Agency Group Compliance Rule (7)
- Compliance Rule Displayable (4)
- Agency Group Compliance Contract (1)
- Agency Candidate Compliance Summary Basic (1)
- Candidate Compliance Summary Expiry (2)
- Agency Candidate Compliance Summary Health (1)
- Compliance Contract Rule (2)
- Agency Compliance Rule Displayable (2)
- Agency Compliance Rule (2)
- Agency Organisation Compliance Contract Link (2)
- Candidate Compliance Summary Basic (1)
- Candidate Compliance Summary Health (1)
- Gong Call (2)
- Calls Search (1)
- Gong CRM Object (1)
- PABX Identifier Settings (9)
- Run Job (1)
- Reference Config (1)
- Reference Online Form Content (6)
- MailboxFolderDeltaSync (7)
- System Workforce (1)
- Agency Group User Activity (1)
- Agency Client Activity (2)
- Agency User Activity (1)
- Advanced Search Report (1)
- Autocomplete (4)
- Global Search (4)
- Saved Search (8)
- Work History Client Summary (1)
- Tags (10)
- TagTypes (2)
- Agency Client Activity Conversation (1)
- Tag Links (15)
- Candidate notification retrieval (2)
- Site Details (1)
- User (1)
- Agency Shift (1)
- Shift status reasons (1)
- Staffing Order (1)
- Agency Organisation Site Ward (1)
- Site Type (1)
- Ward Type (1)
- Agency Candidate Advanced Search (1)
- Agency Group Candidate Advanced Search (1)
- Agency Shift Manifest Advanced Search (1)
- Agency Shift Advanced Search (1)
- Agency Group Agency Shift Advanced Search (1)
- Agency Candidate Possible Shifts Advanced Search (1)
- Agency Client Advanced Search (1)
- Agency Client Event Log Advanced Search (1)
- Data exports (2)
- Candidate Shift Advanced Search (1)
- Agency Group Compliance Rule Exemption (1)
- Agency Compliance Rule Exemption (1)
- Advanced Search Report Booked Candidates (1)
- Agency Previously Booked Candidate Advanced Search (1)

Every operation, with a link to its markdown: https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt