Overview

When you create an API token, the scopes you select decide which REST API endpoints that token can call. Each scope covers one resource, and it is either read-only or read and write.

Add only the scopes your integration needs so the token cannot reach unrelated company data. Many scopes include sensitive data, so treat each one as a deliberate choice.

The token is also limited by the permission profile of the person who created it. API Tokens and Permissions explains how tokens and permission profiles work together.

Scopes

Scope	Description	API endpoints
activity-log.read	Read visible Activity Log events available to the authorized client	GET List visible activity log events retained from the last 90 days GET Retrieve a specific activity log event
app-users.read	Read app users data available to the authorized client	GET List app users GET Retrieve a specific app user
break-policies.read	Read break policies data available to the authorized client	GET List break policies GET Retrieve a specific break policy
break-types.read	Read break types data available to the authorized client	GET List break types GET Retrieve a specific break type
business-partner-groups.read	Read business partner groups data available to the authorized client	GET List business partner groups GET Retrieve a specific business partner group
business-partner-groups.read-write	Read and write business partner groups data available to the authorized client	POST Create a new business partner group DELETE Delete a business partner group
business-partners.read	Read business partners data available to the authorized client	GET List business partners GET Retrieve a specific business partner
business-partners.read-write	Read and write business partners data available to the authorized client	POST Create a new business partner DELETE Delete a business partner
business-structure-paths.read	Read business-structure-paths data available to the authorized client	GET List business-structure-paths GET Retrieve a specific business-structure-path
business-structure-paths.read-write	Read and write business-structure-paths data available to the authorized client	POST Create a new business-structure-path DELETE Delete a business-structure-path
candidate-applications.read	Read candidate applications data available to the authorized client	GET List candidate applications
candidates.read	Read candidates data available to the authorized client	GET List candidates
companies.read	Read companies data available to the authorized client	GET List companies
company-legal-entities.read	Read company legal entities data available to the authorized client	GET List company legal entities GET Retrieve a specific company legal entity
company-legal-entity-workers.read	Read company-legal-entity-workers data available to the authorized client	GET List company-legal-entity-workers GET Retrieve a specific company-legal-entity-worker
compensation-bands-details.read	Read compensation bands details data available to the authorized client	GET List compensation bands details GET Retrieve a specific compensation bands detail
compensations.read	Read compensations data available to the authorized client	GET List compensations GET Retrieve a specific compensation
custom-fields.read	Read custom fields data available to the authorized client	GET List custom fields
custom-object-records.read	Read Custom Object record data available to the authorized client	GET List custom object records POST List custom object records by query GET Retrieve a specific custom object record GET Retrieve a specific custom object record by its external_id
custom-object-records.read-write	Read and write Custom Object record data available to the authorized client	GET List custom object records POST Create or update a custom object record POST List custom object records by query GET Retrieve a specific custom object record PATCH Update a custom object record DELETE Delete a custom object record GET Retrieve a specific custom object record by its external_id POST Bulk create or update custom object records PATCH Bulk Update custom object records POST Bulk delete custom object records
custom-object.read-write.owner		POST Bulk create or update custom object records
custom-objects.read	Read custom-objects data available to the authorized client	GET List custom objects GET Retrieve a specific custom object GET List object categories GET Retrieve a specific object category GET List custom object fields GET Retrieve a specific custom object field
custom-objects.read-write	Read and write custom-objects data available to the authorized client	GET List custom objects GET Retrieve a specific custom object PATCH Update a custom object DELETE Delete a custom object GET List object categories GET Retrieve a specific object category PATCH Update an object category DELETE Delete an object category GET List custom object fields POST Create a new custom object field GET Retrieve a specific custom object field PATCH Update a custom object field DELETE Delete a custom object field
custom-objects.read-write.owner	Create new custom-objects, read and write custom-objects data owned by the authorized client	GET List custom objects POST Create a new custom object GET Retrieve a specific custom object PATCH Update a custom object DELETE Delete a custom object GET List object categories POST Create a new object category GET Retrieve a specific object category PATCH Update an object category DELETE Delete an object category GET List custom object fields POST Create a new custom object field GET Retrieve a specific custom object field PATCH Update a custom object field DELETE Delete a custom object field GET List custom object records POST Create or update a custom object record POST List custom object records by query GET Retrieve a specific custom object record PATCH Update a custom object record DELETE Delete a custom object record GET Retrieve a specific custom object record by its external_id PATCH Bulk Update custom object records POST Bulk delete custom object records
custom-settings.read	Read Custom-settings data available to the authorized client	GET List Setting GET Retrieve a specific Setting
custom-settings.read-write	Read and write Custom-settings data available to the authorized client	POST Create a new Setting PATCH Update a Setting DELETE Delete a Setting
departments.read	Read departments data available to the authorized client	GET List departments GET Retrieve a specific department
departments.read-write	Read and write departments data available to the authorized client	POST Create a new department PATCH Update a department
device-orders.read	Read device orders data available to the authorized client	GET List device orders GET Retrieve a specific device order
devices.read	Read devices data available to the authorized client	GET List devices GET Retrieve a specific device
draft-hires.read-write	Read and write draft hires data available to the authorized client	POST Create bulk draft hire
draft-transitions.read	Read draft transitions data available to the authorized client	GET Retrieve a specific draft transition
draft-transitions.read-write	Read and write draft transitions data available to the authorized client	POST Create a new draft transition
employee-documents.read-write	Read and write employee documents data available to the authorized client	POST Create a new employee document
employment-types.read	Read employment types data available to the authorized client	GET List employment types GET Retrieve a specific employment type
entitlements.read	Read entitlements data available to the authorized client	GET List entitlements
files.read	Read files data available to the authorized client	GET Retrieve a specific file
files.read-write	Read and write files data available to the authorized client	POST Create a new file
function-executions.read	Read function executions data available to the authorized client	GET List function executions GET Retrieve a specific function execution GET List function execution logs
function-executions.read-write	Read and write function executions data available to the authorized client	GET List function executions POST Create a new function execution GET Retrieve a specific function execution GET List function execution logs
function-executions.read-write.owner	Read and write executions for functions the authorizing role can run	GET List function executions POST Create a new function execution GET Retrieve a specific function execution GET List function execution logs
function-executions.write	Write function executions data available to the authorized client	POST Create a new function execution
functions.read	Read functions data available to the authorized client	GET List functions GET Retrieve a specific function GET List function deployments GET Retrieve a specific function deployment GET List function deployment logs
functions.read-write	Read and write functions data available to the authorized client	GET List functions POST Create a new function GET Retrieve a specific function DELETE Delete a function GET List function deployments POST Create a new function deployment GET Retrieve a specific function deployment GET List function deployment logs POST Create a new function dev bundle
headcount-positions.read	Read headcount positions data available to the authorized client	GET List headcount positions GET Retrieve a specific headcount position
headcount-priorities.read	Read headcount priorities data available to the authorized client	GET List headcount priorities GET Retrieve a specific headcount priority
job-assignments.read	Read job assignments data available to the authorized client	GET List job assignments GET Retrieve a specific job assignment GET List attribute change logs
job-assignments.read-write	Read and write job assignments data available to the authorized client	POST Create a new job assignment PATCH Update a job assignment DELETE Delete a job assignment
job-codes.read	Read job codes data available to the authorized client	GET List job codes GET Retrieve a specific job code GET List attribute change logs
job-codes.read-write	Read and write job codes data available to the authorized client	POST Create a new job code PATCH Update a job code DELETE Delete a job code
job-dimensions.read	Read job dimensions data available to the authorized client	GET List job dimensions GET Retrieve a specific job dimension
job-dimensions.read-write	Read and write job dimensions data available to the authorized client	POST Create a new job dimension PATCH Update a job dimension DELETE Delete a job dimension
job-functions.read	Read job functions data available to the authorized client	GET List job functions GET Retrieve a specific job function
job-pay-rate-exceptions.read	Read job pay rate exceptions data available to the authorized client	GET List job pay rate exceptions GET Retrieve a specific job pay rate exception GET List attribute change logs
job-requisitions-write.read-write	Read and write job requisitions data available to the authorized client	POST Create a new job requisition
job-requisitions.read	Read job requisitions data available to the authorized client	GET List job requisitions
kiosk-badges.read	Read kiosk badges data available to the authorized client	GET List kiosk badges GET Retrieve a specific kiosk badge
kiosk-badges.read-write	Read and write kiosk badges data available to the authorized client	POST Create a new kiosk badge PATCH Update a kiosk badge DELETE Delete a kiosk badge
leave-accruals.read	Read leave accruals data available to the authorized client	GET List leave accruals GET Retrieve a specific leave accrual
leave-accruals.read-write	Read and write leave accruals data available to the authorized client	POST Create a new leave accrual
leave-balances.read	Read leave balances data available to the authorized client	GET List leave balances GET Retrieve a specific leave balance
leave-requests.read	Read leave requests data available to the authorized client	GET List leave requests GET Retrieve a specific leave request
leave-requests.read-write	Read and write leave requests data available to the authorized client	POST Create a new leave request PATCH Update a leave request
leave-types.read	Read leave types data available to the authorized client	GET List leave types GET Retrieve a specific leave type
legal-entities.read	Read legal entities data available to the authorized client	GET List legal entities GET Retrieve a specific legal entity
levels.read	Read levels data available to the authorized client	GET List levels GET Retrieve a specific level
levels.read-write	Read and write levels data available to the authorized client	POST Create a new level PATCH Update a level DELETE Delete a level
location-factors.read	Read location factors data available to the authorized client	GET List location factors GET Retrieve a specific location factor
scheduled-job-assignments.read	Read scheduled job assignments data available to the authorized client	GET List scheduled job assignments GET Retrieve a specific scheduled job assignment
scheduled-job-assignments.read-write	Read and write scheduled job assignments data available to the authorized client	DELETE Delete a scheduled job assignment
schedules.read	Read schedules data available to the authorized client	GET List schedules GET Retrieve a specific schedule
schedules.read-write	Read and write schedules data available to the authorized client	POST Create a new schedule PATCH Update a schedule
shift-inputs.read	Read shift inputs data available to the authorized client	GET List shift inputs GET Retrieve a specific shift input
shift-inputs.read-write	Read and write shift inputs data available to the authorized client	POST Create a new shift input PATCH Update a shift input DELETE Delete a shift input
shiftassignments.read	Read shift assignments data available to the authorized client	GET List shift assignments GET Retrieve a specific shift assignment
shiftassignments.read-write	Read and write shift assignments data available to the authorized client	POST Create a new shift assignment PATCH Update a shift assignment PATCH Update custom fields for a shift assignment
sites.read	Read Sites data available to the authorized client	GET List Sites GET Retrieve a specific site GET List files in the active bundle
sites.read-write	Read and write Sites data available to the authorized client	POST Create a new site PATCH Update a site DELETE Delete a site POST Create a presigned staged upload batch POST Apply file operations to a site bundle
software-deployments.read	Read software deployment details	GET List software deployments GET Retrieve a specific software deployment
software-deployments.read-write	Read and write software deployments data available to the authorized client	POST Create a new software deployment PATCH Update a software deployment DELETE Delete a software deployment
sso-me.read	Read sso-me data available to the authorized client	GET Retrieve my SSO information
supergroups.read	Read supergroups data available to the authorized client	GET List supergroups GET Retrieve a specific supergroup GET List supergroup members GET List supergroup inclusion members GET List supergroup exclusion members
supergroups.read-write	Read and write supergroups data available to the authorized client	PATCH Update supergroup inclusion members PATCH Update supergroup exclusion members
teams.read	Read teams data available to the authorized client	GET List teams GET Retrieve a specific team
teams.read-write	Read and write teams data available to the authorized client	POST Create a new team PATCH Update a team DELETE Delete a team
time-cards.read	Read time cards data available to the authorized client	GET List time cards GET Retrieve a specific time card
time-entries.read	Read time entries data available to the authorized client	GET List time entries GET Retrieve a specific time entry
time-entries.read-write	Read and write time entries data available to the authorized client	POST Create a new time entry PATCH Update a time entry DELETE Delete a time entry
titles.read	Read titles data available to the authorized client	GET List titles GET Retrieve a specific title
titles.read-write	Read and write titles data available to the authorized client	POST Create a new title PATCH Update a title DELETE Delete a title
tracks.read	Read tracks data available to the authorized client	GET List tracks GET Retrieve a specific track
tracks.read-write	Read and write tracks data available to the authorized client	POST Create a new track PATCH Update a track DELETE Delete a track
unassignedshifts.read	Read unassigned shifts data available to the authorized client	GET List unassigned shifts GET Retrieve a specific unassigned shift
unassignedshifts.read-write	Read and write unassigned shifts data available to the authorized client	POST Create a new unassigned shift PATCH Update a unassigned shift PATCH Update custom fields for a unassigned shift POST Assign a worker to an unassigned shift
users.read	Read users data available to the authorized client	GET List users GET Retrieve a specific user
work-locations.read	Read work locations data available to the authorized client	GET List work locations GET Retrieve a specific work location
work-locations.read-write	Read and write work locations data available to the authorized client	POST Create a new work location PATCH Update a work location DELETE Delete a work location
worker-time-splits.read	Read worker time splits data available to the authorized client	GET List worker time splits GET Retrieve a specific worker time split
worker-time-splits.read-write	Read and write worker time splits data available to the authorized client	POST Create a new worker time split PATCH Update a worker time split DELETE Delete a worker time split
workers.read	Read workers data available to the authorized client	GET List workers GET Retrieve a specific worker
workflow-executions.read	Read workflow executions available to the authorized client	GET Retrieve a workflow execution
workflow-executions.read-write	Read and write workflow executions available to the authorized client	POST Execute a workflow GET Retrieve a workflow execution
workflows.read	Read workflows available to the authorized client	GET List workflows GET Retrieve a workflow
workflows.read-write	Read and write workflows available to the authorized client	POST Create a workflow PATCH Update a workflow DELETE Delete a workflow