/
ST
staffshift
/
Staffshift API Gateway
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 5h ago · Updated 1d ago
Details
Filter operations
Acl Groups
7
Activity Type
2
Advanced Search Report
1
Advanced Search Report Booked Candidates
1
Agency Agency Group
1
Agency Candidate Activity
2
Agency Candidate Activity Conversation
1
Agency Candidate Activity Email
1
Agency Candidate Additional Note
2
Agency Candidate Address Details
6
Agency Candidate Advanced Search
1
Agency Candidate Availability
2
Agency Candidate Bulk Notification
1
Agency Candidate Compliance Summary Basic
1
Agency Candidate Compliance Summary Health
1
Agency Candidate Contact Numbers
5
Agency Candidate Document Types
1
Agency Candidate Documents
4
Agency Candidate Email Details
4
Agency Candidate Employment
4
Agency Candidate Employment Dismissals
2
Agency Candidate Employment Position Held
1
Agency Candidate Invitation Verification
1
Agency Candidate Languages
5
Agency Candidate Meta
1
Agency Candidate Notifications
1
Agency Candidate Other Names
2
Agency Candidate Position Held Status
1
Agency Candidate Possible Shifts Advanced Search
1
Agency Candidate Qualifications
2
Agency Candidate Registration Body
2
Agency Candidate Settings
1
Agency Candidate Skills
2
Agency Candidate Social Link
5
Agency Candidate Status
2
Agency Candidate Status Summary
1
Agency Candidate Type
1
Agency Client Activity
2
Agency Client Activity Conversation
1
Agency Client Advanced Search
1
Agency Client Event Log Advanced Search
1
Agency Compliance Rule
2
Agency Compliance Rule Displayable
2
Agency Compliance Rule Exemption
1
Agency Compliance Summary Settings
1
Agency Contact Numbers
4
Agency Contract
1
Agency Group Agency
1
Agency Group Agency Shift Advanced Search
1
Agency Group Candidate
14
Agency Group Candidate Activity
2
Agency Group Candidate Activity Conversation
1
Agency Group Candidate Activity Email
1
Agency Group Candidate Additional Note
2
Agency Group Candidate Address Details
6
Agency Group Candidate Advanced Search
1
Agency Group Candidate Bulk Notification
1
Agency Group Candidate Compilation Changes
1
Agency Group Candidate Compliance Summary Expiry
1
Agency Group Candidate Compliance Summary Health
1
Agency Group Candidate Consultant
6
Agency Group Candidate Contact Numbers
5
Agency Group Candidate Document Types
1
Agency Group Candidate Documents
4
Agency Group Candidate Email Details
4
Agency Group Candidate Employment
4
Agency Group Candidate Employment Dismissals
5
Agency Group Candidate Employment Position Held
1
Agency Group Candidate Invitation Verification
1
Agency Group Candidate Meta
4
Agency Group Candidate Misc
2
Agency Group Candidate Notification
2
Agency Group Candidate Notifications
1
Agency Group Candidate OtherNames
2
Agency Group Candidate Position Held Status
1
Agency Group Candidate Qualifications
6
Agency Group Candidate Registration
1
Agency Group Candidate Registration Body
5
Agency Group Candidate Registration Body entry
2
Agency Group Candidate Registration Body Entry
1
Agency Group Candidate Reports
1
Agency Group Candidate Settings
2
Agency Group Candidate Skills
2
Agency Group Candidate Social Link
5
Agency Group Candidate Stated Skills
4
Agency Group Candidate Status
3
Agency Group Candidate Status History
2
Agency Group Candidate Status Summary
1
Agency Group Candidate Type
1
Agency Group Candidate Widgets
4
Agency Group Compliance Contract
1
Agency Group Compliance Rule
7
Agency Group Compliance Rule Exemption
1
Agency Group Compliance Summary Basic
1
Agency Group Compliance Summary Settings
2
Agency Group Consultant Role
3
Agency Group Document Types
4
Agency group ip whitelist all access user
3
Agency group ip-whitelist
4
Agency Group Job Title
1
Agency Group Lookup
4
Agency Group Notification Type
3
Agency Group Notification Type Templates
1
Agency Group Policy
2
Agency Group Policy Action
1
Agency Group Policy Type
4
Agency Group Registration Settings
3
Agency Group status details
6
Agency Group Status Reason
4
Agency Group User Activity
1
Agency Group User Avatar
3
Agency Group Users
2
Agency Group Webhook Settings
1
Agency Group Webhook Subscription
1
Agency Group Webhook Subscription Notifications
1
Agency Group Webhook Topic
1
Agency ip whitelist all access user
3
Agency ip-whitelist
4
Agency Job Title
1
Agency Linked Clients
1
Agency Lookup
4
Agency Notification Type Templates
1
Agency Organisation
1
Agency Organisation Compliance Contract Link
2
Agency Organisation Site Ward
1
Agency Previously Booked Candidate Advanced Search
1
Agency Shift
1
Agency Shift Advanced Search
1
Agency Shift Manifest Advanced Search
1
Agency Status Details
3
Agency User
1
Agency User Activity
1
Agency User Avatar
3
Agency Users
2
AgencyCandidate
11
AgencyGroup
4
Autocomplete
4
Calls Search
1
Candidate
12
Candidate Address Details
5
Candidate Availability
2
Candidate Basic Info
2
Candidate Booked Shifts
1
Candidate Compliance Contract Rule Summary
2
Candidate Compliance Summary Basic
1
Candidate Compliance Summary Expiry
2
Candidate Compliance Summary Health
1
Candidate Contact Numbers
5
Candidate Conversation
2
Candidate Document Types
1
Candidate Documents
3
get
Retrieves a list of Documents for specific candidate
post
Create a document for a candidate
get
Retrieve a specific document for specific candidate
Candidate Email Details
4
Candidate Email Verify
1
Candidate Employment
5
Candidate Employment Dismissals
5
Candidate Employment Position Held
1
Candidate Equality Details
2
Candidate Misc Details
2
Candidate Next Of Kin
5
Candidate notification retrieval
2
Candidate Notification Send Preview
2
Candidate Notification Settings
3
Candidate Notification Types
2
Candidate Notifications
2
Candidate Other Names
2
Candidate Position Held Status
1
Candidate Position Held Work History Breakdown
2
Candidate Qualifications
5
Candidate Registration Body
5
Candidate Settings
3
Candidate Shift Advanced Search
1
Candidate Skills
2
Candidate Social Link
5
Candidate Stated Skills
3
Candidate Widgets
1
CandidateInvitation
2
CandidatePlugin
4
Chat
14
Compliance Contract
6
Compliance Contract Rule
2
Compliance Contract Rule Summary
2
Compliance Rule Displayable
4
Context Candidate Notifications
2
Context Notification
2
Context Notification Type Templates
10
Context Notification Types
6
Contract Link
2
Conversation
5
Conversation Chatterbox Profiles
3
Conversation Webhooks
1
Data exports
2
Firebase custom token
1
Global Search
4
Gong Call
2
Gong CRM Object
1
Industry
1
Job Family
2
Job Title
1
Languages
1
Lookup
1
MailboxFolderDeltaSync
7
Message Webhooks
2
Notification Groups
4
Notification Tokens
5
Notification Types
7
PABX Identifier Settings
9
Plugin Setting
2
Policy
10
Processed Policy
2
Reference Config
1
Reference Online Form Content
6
Resource Policies
2
Run Job
1
Saved Search
8
Shift status reasons
1
Site Details
1
Site Type
1
SocialLinkType
4
Staffing Order
1
Staffshift Policy
3
Staffshift Policy Type
4
Staffshift Policy type version
2
Status
1
System Activity Type
4
System Document Types
4
System Job Family
2
System Job Title
2
System position types
3
System Qualifications
4
System Registration Body
5
System Registration Body Entries
5
System Registration Body Entry Status
4
System Registration Body Status
4
System skills
4
System Workforce
1
Tag Links
15
Tags
10
TagTypes
2
Teams
4
Timesheet
2
Timezone Lookup
1
User
1
User Avatar
4
User Check Email
1
User integrations
1
User Plugins
4
Username Suggestion and availability
1
Ward Type
1
Webhook Mailgun
1
Webhooks
2
Work History Client Summary
1
Candidate Documents
Create a document for a candidate
post
/candidate/{candidate_id}/documents
Request body
DocumentInputBodyParam
required
Candidate document details
type_id
string
required
metadata
object
required
Response
The created document details
DocumentUploadResult
required
_id
string
required
signed_upload_url
string
headers
object[]
Changes