Skip to content

Reference

Rippling

Connect a Rippling company API token to Alter Vault for governed access to HR, IT, and payroll data

Rippling runs HR, IT, payroll, and workforce management. A Rippling company can create an API token for its own account and store it in Alter Vault; agents then call Rippling’s REST API through Alter without ever holding the token, and every call is governed by Alter policy.

This page covers the company API token. To connect customers’ Rippling companies through a Rippling App Shop listing (OAuth), see Rippling OAuth.

PropertyValue
Provider IDrippling
CategoryHR
Credential TypeAPI Token
API hostrest.ripplingapis.com

Open API Tokens

Sign in to Rippling as a user allowed to create API tokens and open Tools → Developer → API Tokens.

Create the token

Click Create API token, enter a name and a unique identifier, and choose the current API version: the token calls the V2 REST API at rest.ripplingapis.com, the host the setup below allows. Alter’s policy catalog also classifies legacy V1 Platform API calls (api.rippling.com) if that host is allowed too, except POST New Candidate, which Rippling does not accept with API tokens.

Select scopes

Select the scopes the integration needs. Include companies.read: Alter reads the company with it to verify the token when you save it.

Copy the token

Copy the token. Rippling shows it only once.

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Rippling

Go to Managed Secrets > Add Provider > Rippling.

Enter the token

Paste the API token into the credential field and set the allowed host to rest.ripplingapis.com.

Save

Click Save. You’ll receive a grant_id to use with the SDK. Alter checks the token with Rippling when you save: a token Rippling rejects is refused, and a valid token without companies.read is saved with a “could not verify” notice.

response = await alter_app.request(
HttpMethod.GET,
"https://rest.ripplingapis.com/workers/",
grant_id="YOUR_GRANT_ID",
query_params={"limit": "50"},
)

Every call made with a Rippling grant runs through Alter’s policy rules: method and endpoint restrictions, IP allowlists, time windows, quotas, human approval, AI review, and content rules that deny, redact, or require step-up. Rules can be attached to the organization, the application, an agent, a grant, an end user, or this managed secret.

Content rules can name a Rippling operation from the table below, a family, or a request field:

FamilyRippling operations it covers
readEvery GET, plus the read-only POST queries (custom-object record queries, metadata extract and validate)
writeEvery create and update
deleteEvery DELETE, plus bulk deletion of custom-object records
paymentWrites that move money or change what people are paid: off-cycle payroll runs, payroll payment-mode changes, variable-compensation payouts, earnings inputs, job-assignment and job-code pay rates, leave accruals (including balance payouts), time entries and worker time splits, and hires (which carry compensation)
sendWrites that notify people or can act on their own: hires, background-check candidates, employee documents, leave requests, published or assigned shifts, Rippling AI agent sessions and their messages, and function or workflow-action executions
adminOrg structure (departments, teams, levels, titles, tracks, job codes and dimensions, work locations, business partners), groups and supergroup membership, custom objects and apps, packages, sandboxes, sites, workflows, functions, agents, software deployments, and kiosk badges

Typical rules:

  • Require human approval for the payment family, so no payroll run or payout happens without a person approving it.
  • Deny the delete family on agent grants.
  • Restrict a grant to GET on /workers/* for a read-only reporting agent.
  • Redact a free-text body field such as reason_for_leave before a leave request reaches Rippling.

Use alter policy simulate or Explain a request in the Developer Portal to see which operation and family a Rippling request classifies as before you rely on a rule. See Policies and Set policies.

  • The token is injected as Authorization: Bearer <token>.
  • Rippling revokes a token automatically when its owner is terminated or when it goes unused for more than 30 days. When that happens, calls return HTTP 401; rotate the managed secret with a new token.
  • The token stays on the API version chosen at creation until its owner or an admin changes it.
  • Rippling’s V2 REST API (rest.ripplingapis.com) allows 600 requests per 10 seconds per token for each endpoint path, and answers HTTP 429 with Retry-After beyond that.
  • Rippling enforces the token’s scopes itself. A call outside them returns HTTP 403 from Rippling.
  • Rippling describes an API token as a credential that acts as the user who created it, and models third-party access as a separate user account. Rippling’s Developer Terms of Use restrict third-party systems, including AI agents, from using a Rippling API key. Confirm with Rippling that storing the company’s token in Alter is acceptable before relying on it.

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation IDFamiliesMethodProvider path
list-activity-logreadGET/activity-log/
get-activity-logreadGET/activity-log/{id}/
list-agentsreadGET/agents/
create-agentsadmin, writePOST/agents/
create-agent-sessionsend, writePOST/agents/sessions/
get-agent-sessionreadGET/agents/sessions/{session_id}/
list-agent-session-eventsreadGET/agents/sessions/{session_id}/events/
append-agent-session-messagesend, writePOST/agents/sessions/{session_id}/messages/
capture-agent-session-resume-statewritePOST/agents/sessions/{session_id}/resume-state/
delete-agentadmin, deleteDELETE/agents/{agent_id}/
get-agentreadGET/agents/{agent_id}/
update-agentadmin, writePATCH/agents/{agent_id}/
list-agent-deploymentsreadGET/agents/{agent_id}/deployments/
create-agent-deploymentadmin, writePOST/agents/{agent_id}/deployments/
get-agent-deploymentreadGET/agents/{agent_id}/deployments/{deployment_id}/
list-agent-sessionsreadGET/agents/{agent_id}/sessions/
list-agent-source-revisionsreadGET/agents/{agent_id}/source-revisions/
create-agent-source-revisionadmin, writePOST/agents/{agent_id}/source-revisions/
get-agent-source-revisionreadGET/agents/{agent_id}/source-revisions/{source_revision_id}/
list-app-usersreadGET/app-users/
get-app-usersreadGET/app-users/{id}/
list-background-check-candidatesreadGET/background-check-candidates/
create-background-check-candidatessend, writePOST/background-check-candidates/
delete-background-check-candidatesdeleteDELETE/background-check-candidates/{id}/
get-background-check-candidatesreadGET/background-check-candidates/{id}/
update-background-check-candidatessend, writePATCH/background-check-candidates/{id}/
list-break-policiesreadGET/break-policies/
get-break-policiesreadGET/break-policies/{id}/
list-break-typesreadGET/break-types/
get-break-typesreadGET/break-types/{id}/
list-business-partner-groupsreadGET/business-partner-groups/
create-business-partner-groupsadmin, writePOST/business-partner-groups/
delete-business-partner-groupsadmin, deleteDELETE/business-partner-groups/{id}/
get-business-partner-groupsreadGET/business-partner-groups/{id}/
list-business-partnersreadGET/business-partners/
create-business-partnersadmin, writePOST/business-partners/
delete-business-partnersadmin, deleteDELETE/business-partners/{id}/
get-business-partnersreadGET/business-partners/{id}/
list-business-structure-pathsreadGET/business-structure-paths/
create-business-structure-pathsadmin, writePOST/business-structure-paths/
delete-business-structure-pathsadmin, deleteDELETE/business-structure-paths/{id}/
get-business-structure-pathsreadGET/business-structure-paths/{id}/
list-candidate-applicationsreadGET/candidate-applications/
list-candidatesreadGET/candidates/
list-companiesreadGET/companies/
list-company-legal-entitiesreadGET/company-legal-entities/
get-company-legal-entitiesreadGET/company-legal-entities/{id}/
list-company-legal-entity-workersreadGET/company-legal-entity-workers/
get-company-legal-entity-workersreadGET/company-legal-entity-workers/{id}/
list-compensation-bands-detailsreadGET/compensation-bands-details/
get-compensation-bands-detailsreadGET/compensation-bands-details/{id}/
list-compensationsreadGET/compensations/
get-compensationsreadGET/compensations/{id}/
list-custom-appsreadGET/custom-apps/
create-custom-appsadmin, writePOST/custom-apps/
delete-custom-appsadmin, deleteDELETE/custom-apps/{id}/
get-custom-appsreadGET/custom-apps/{id}/
update-custom-appsadmin, writePATCH/custom-apps/{id}/
list-custom-fieldsreadGET/custom-fields/
list-custom-objectsreadGET/custom-objects/
create-custom-objectsadmin, writePOST/custom-objects/
delete-custom-objectsadmin, deleteDELETE/custom-objects/{custom_object_api_name}/
get-custom-objectsreadGET/custom-objects/{custom_object_api_name}/
update-custom-objectsadmin, writePATCH/custom-objects/{custom_object_api_name}/
list-custom-objects/(custom-object-api-name)/fieldsreadGET/custom-objects/{custom_object_api_name}/fields/
create-custom-objects/(custom-object-api-name)/fieldsadmin, writePOST/custom-objects/{custom_object_api_name}/fields/
delete-custom-objects/(custom-object-api-name)/fieldsadmin, deleteDELETE/custom-objects/{custom_object_api_name}/fields/{field_api_name}/
get-custom-objects/(custom-object-api-name)/fieldsreadGET/custom-objects/{custom_object_api_name}/fields/{field_api_name}/
update-custom-objects/(custom-object-api-name)/fieldsadmin, writePATCH/custom-objects/{custom_object_api_name}/fields/{field_api_name}/
list-custom-objects/(custom-object-api-name)/recordsreadGET/custom-objects/{custom_object_api_name}/records/
create-custom-objects/(custom-object-api-name)/recordswritePOST/custom-objects/{custom_object_api_name}/records/
bulk-delete-custom-objects/(custom-object-api-name)/recordsdeletePOST/custom-objects/{custom_object_api_name}/records/bulk-delete/
bulk-update-custom-objects/(custom-object-api-name)/recordswritePATCH/custom-objects/{custom_object_api_name}/records/bulk/
bulk-create-custom-objects/(custom-object-api-name)/recordswritePOST/custom-objects/{custom_object_api_name}/records/bulk/
get-custom-objects/(custom-object-api-name)/records-by-external-idreadGET/custom-objects/{custom_object_api_name}/records/external_id/{external_id}/
list-by-query-custom-objects/(custom-object-api-name)/recordsreadPOST/custom-objects/{custom_object_api_name}/records/query/
delete-custom-objects/(custom-object-api-name)/recordsdeleteDELETE/custom-objects/{custom_object_api_name}/records/{codr_id}/
get-custom-objects/(custom-object-api-name)/recordsreadGET/custom-objects/{custom_object_api_name}/records/{codr_id}/
update-custom-objects/(custom-object-api-name)/recordswritePATCH/custom-objects/{custom_object_api_name}/records/{codr_id}/
list-custom-pagesreadGET/custom-pages/
create-custom-pagesadmin, writePOST/custom-pages/
delete-custom-pagesadmin, deleteDELETE/custom-pages/{id}/
get-custom-pagesreadGET/custom-pages/{id}/
update-custom-pagesadmin, writePATCH/custom-pages/{id}/
list-custom-settingsreadGET/custom-settings/
create-custom-settingsadmin, writePOST/custom-settings/
delete-custom-settingsadmin, deleteDELETE/custom-settings/{api_name}/
get-custom-settingsreadGET/custom-settings/{api_name}/
update-custom-settingsadmin, writePATCH/custom-settings/{api_name}/
list-departmentsreadGET/departments/
create-departmentsadmin, writePOST/departments/
get-departmentsreadGET/departments/{id}/
update-departmentsadmin, writePATCH/departments/{id}/
list-developer-program-applicationreadGET/developer-program-application/
create-developer-program-applicationadmin, writePOST/developer-program-application/
list-developer-usersreadGET/developer-users/
list-device-ordersreadGET/device-orders/
get-device-ordersreadGET/device-orders/{id}/
list-devicesreadGET/devices/
get-devicesreadGET/devices/{id}/
create-draft-hireswritePOST/draft-hires/
create-draft-transitionswritePOST/draft-transitions/
get-draft-transitionsreadGET/draft-transitions/{id}/
list-earning-typesreadGET/earning-types/
list-earnings-inputsreadGET/earnings-inputs/
create-earnings-inputspayment, writePOST/earnings-inputs/
delete-earnings-inputsdelete, paymentDELETE/earnings-inputs/{id}/
create-employee-documentssend, writePOST/employee-documents/
list-employment-typesreadGET/employment-types/
get-employment-typesreadGET/employment-types/{id}/
list-entitlementsreadGET/entitlements/
create-fileswritePOST/files/
get-filesreadGET/files/{id}/
list-functionsreadGET/functions/
create-functionsadmin, writePOST/functions/
get-functionsreadGET/functions/{function_api_name}/
update-functionsadmin, writePATCH/functions/{function_api_name}/
list-functions/(function-api-name)/deploymentsreadGET/functions/{function_api_name}/deployments/
create-functions/(function-api-name)/deploymentsadmin, writePOST/functions/{function_api_name}/deployments/
get-functions/(function-api-name)/deploymentsreadGET/functions/{function_api_name}/deployments/{deployment_id}/
list-functions/(function-api-name)/deployments/(deployment-id)/logsreadGET/functions/{function_api_name}/deployments/{deployment_id}/logs/
create-functions/(function-api-name)/dev_bundlesadmin, writePOST/functions/{function_api_name}/dev_bundles/
list-functions/(function-api-name)/executionsreadGET/functions/{function_api_name}/executions/
create-functions/(function-api-name)/executionssend, writePOST/functions/{function_api_name}/executions/
get-functions/(function-api-name)/executionsreadGET/functions/{function_api_name}/executions/{execution_id}/
list-functions/(function-api-name)/executions/(execution-id)/logsreadGET/functions/{function_api_name}/executions/{execution_id}/logs/
list-headcount-positionsreadGET/headcount-positions/
get-headcount-positionsreadGET/headcount-positions/{id}/
list-headcount-prioritiesreadGET/headcount-priorities/
get-headcount-prioritiesreadGET/headcount-priorities/{id}/
get-hire-requirementsreadGET/hire-requirements/
create-hirespayment, send, writePOST/hires/
list-job-assignmentsreadGET/job-assignments/
create-job-assignmentspayment, writePOST/job-assignments/
delete-job-assignmentsdelete, paymentDELETE/job-assignments/{id}/
get-job-assignmentsreadGET/job-assignments/{id}/
update-job-assignmentspayment, writePATCH/job-assignments/{id}/
list-job-assignments/{job_assignment_id}/change-logreadGET/job-assignments/{job_assignment_id}/change-log/
list-job-codesreadGET/job-codes/
create-job-codesadmin, payment, writePOST/job-codes/
delete-job-codesadmin, deleteDELETE/job-codes/{id}/
get-job-codesreadGET/job-codes/{id}/
update-job-codesadmin, payment, writePATCH/job-codes/{id}/
list-job-codes/{job_code_id}/change-logreadGET/job-codes/{job_code_id}/change-log/
list-job-dimensionsreadGET/job-dimensions/
create-job-dimensionsadmin, writePOST/job-dimensions/
delete-job-dimensionsadmin, deleteDELETE/job-dimensions/{id}/
get-job-dimensionsreadGET/job-dimensions/{id}/
update-job-dimensionsadmin, writePATCH/job-dimensions/{id}/
list-job-functionsreadGET/job-functions/
get-job-functionsreadGET/job-functions/{id}/
list-job-pay-rate-exceptionsreadGET/job-pay-rate-exceptions/
get-job-pay-rate-exceptionsreadGET/job-pay-rate-exceptions/{id}/
list-job-pay-rate-exceptions/{job_pay_rate_exception_id}/change-logreadGET/job-pay-rate-exceptions/{job_pay_rate_exception_id}/change-log/
create-job-requisitions-writewritePOST/job-requisitions-write/
list-job-requisitionsreadGET/job-requisitions/
list-kiosk-badgesreadGET/kiosk-badges/
create-kiosk-badgesadmin, writePOST/kiosk-badges/
delete-kiosk-badgesadmin, deleteDELETE/kiosk-badges/{id}/
get-kiosk-badgesreadGET/kiosk-badges/{id}/
update-kiosk-badgesadmin, writePATCH/kiosk-badges/{id}/
list-leave-accrualsreadGET/leave-accruals/
create-leave-accrualspayment, writePOST/leave-accruals/
get-leave-accrualsreadGET/leave-accruals/{id}/
list-leave-balancesreadGET/leave-balances/
get-leave-balancesreadGET/leave-balances/{id}/
create-leave-program-evaluationswritePOST/leave-program-evaluations/
list-leave-requestsreadGET/leave-requests/
create-leave-requestssend, writePOST/leave-requests/
get-leave-requestsreadGET/leave-requests/{id}/
update-leave-requestssend, writePATCH/leave-requests/{id}/
list-leave-typesreadGET/leave-types/
get-leave-typesreadGET/leave-types/{id}/
list-legal-entitiesreadGET/legal-entities/
get-legal-entitiesreadGET/legal-entities/{id}/
list-levelsreadGET/levels/
create-levelsadmin, writePOST/levels/
delete-levelsadmin, deleteDELETE/levels/{id}/
get-levelsreadGET/levels/{id}/
update-levelsadmin, writePATCH/levels/{id}/
list-listing-submissionsreadGET/listing-submissions/
get-listing-submissionsreadGET/listing-submissions/{id}/
list-listing-transitionsreadGET/listing-transitions/
list-listingreadGET/listing/
create-listingadmin, writePOST/listing/
get-listingreadGET/listing/{id}/
update-listingadmin, writePATCH/listing/{id}/
delist-listingadmin, writePOST/listing/{listing_id}/delist/
publish-listingadmin, writePOST/listing/{listing_id}/publish/
resubmit-listingadmin, writePOST/listing/{listing_id}/resubmit/
submit-listingadmin, writePOST/listing/{listing_id}/submit/
withdraw-listingadmin, writePOST/listing/{listing_id}/withdraw/
list-location-factorsreadGET/location-factors/
get-location-factorsreadGET/location-factors/{id}/
deploy-metadata-componentsadmin, writePOST/metadata/deploy/
create-metadata-deployment-runadmin, writePOST/metadata/deployment-runs/
get-metadata-deployment-runreadGET/metadata/deployment-runs/{run_id}/
extract-metadata-componentsreadGET/metadata/extract/
extract-metadata-components-by-identifiersreadPOST/metadata/extract/
get-metadata-schemareadGET/metadata/schema/
list-metadata-typesreadGET/metadata/types/
validate-metadata-componentsreadPOST/metadata/validate/
create-metadata-validation-runwritePOST/metadata/validation-runs/
get-metadata-validation-runreadGET/metadata/validation-runs/{run_id}/
list-object-categoriesreadGET/object-categories/
create-object-categoriesadmin, writePOST/object-categories/
delete-object-categoriesadmin, deleteDELETE/object-categories/{id}/
get-object-categoriesreadGET/object-categories/{id}/
update-object-categoriesadmin, writePATCH/object-categories/{id}/
install-package-installsadmin, writePOST/package-installs/
get-package-installsreadGET/package-installs/{tracker_id}/
install-package-managed-installsadmin, writePOST/package-managed-installs/
get-package-managed-installsreadGET/package-managed-installs/{install_id}/
create-package-sandbox-linksadmin, writePOST/package-sandbox-links/
get-package-sandbox-linksreadGET/package-sandbox-links/{tracker_id}/
uninstall-package-uninstallsadmin, writePOST/package-uninstalls/
get-package-uninstallsreadGET/package-uninstalls/{tracker_id}/
upgrade-package-upgradesadmin, writePOST/package-upgrades/
get-package-upgradesreadGET/package-upgrades/{tracker_id}/
update-package-version-component-updatesadmin, writePOST/package-version-component-updates/
get-package-version-component-updatesreadGET/package-version-component-updates/{tracker_id}/
get-package-versionsreadGET/package-versions/{version_id}/
update-package-versionsadmin, writePATCH/package-versions/{version_id}/
publish-package-versionsadmin, writePOST/package-versions/{version_id}/publish/
list-packagesreadGET/packages/
create-packagesadmin, writePOST/packages/
delete-packagesadmin, deleteDELETE/packages/{package_key}/
get-packagesreadGET/packages/{package_key}/
update-packagesadmin, writePATCH/packages/{package_key}/
list-available-package-upgradesreadGET/packages/{package_key}/available-upgrades/
create-next-package-versionsadmin, writePOST/packages/{package_key}/next-versions/
list-package-versionsreadGET/packages/{package_key}/versions/
create-package-versionsadmin, writePOST/packages/{package_key}/versions/
create-payroll-payment-mode-changespayment, writePOST/payroll-payment-mode-changes/
list-payroll-runsreadGET/payroll-runs/
create-payroll-runs/off-cyclepayment, writePOST/payroll-runs/off-cycle/
get-payroll-runsreadGET/payroll-runs/{id}/
list-worker-payroll-recordsreadGET/payroll-runs/{run_id}/worker-payroll-records/
list-platform-capabilitiesreadGET/platform-capabilities/
v1.get-app-app_matching_usersreadGET/platform/api/app_detail/app_matching_users
v1.get-companiesreadGET/platform/api/companies/current
v1.get-company_activityreadGET/platform/api/company_activity
v1.get-company_leave_typesreadGET/platform/api/company_leave_types
v1.get-custom_fieldsreadGET/platform/api/custom_fields
v1.get-departmentsreadGET/platform/api/departments
v1.get-employeesreadGET/platform/api/employees
v1.get-employees-include_terminatedreadGET/platform/api/employees/include_terminated
v1.get-employees-employeeIdreadGET/platform/api/employees/{employeeId}
v1.get-groupsreadGET/platform/api/groups
v1.post-groupsadmin, writePOST/platform/api/groups
v1.delete-groups-groupIdadmin, deleteDELETE/platform/api/groups/{groupId}
v1.get-groups-groupIdreadGET/platform/api/groups/{groupId}
v1.patch-groups-groupIdadmin, writePATCH/platform/api/groups/{groupId}
v1.put-groups-groupIdadmin, writePUT/platform/api/groups/{groupId}
v1.get-leave_balancesreadGET/platform/api/leave_balances
v1.get-leave_balancereadGET/platform/api/leave_balances/{role}
v1.get-leave_requestsreadGET/platform/api/leave_requests
v1.post-leave_requestssend, writePOST/platform/api/leave_requests
v1.patch-leave_requests-leaveRequestIdsend, writePATCH/platform/api/leave_requests/{id}
v1.cancel-leave_requestssend, writePOST/platform/api/leave_requests/{id}/cancel
v1.process-leave_requestssend, writePOST/platform/api/leave_requests/{id}/process
v1.get-levelsreadGET/platform/api/levels
v1.post-mark_app_installedwritePOST/platform/api/mark_app_installed
v1.get-mereadGET/platform/api/me
v1.get-saml-idp_metadatareadGET/platform/api/saml/idp_metadata
v1.get-teamsreadGET/platform/api/teams
v1.get-work_locationsreadGET/platform/api/work_locations
trigger-report-runswritePOST/report-runs/
get-report-runsreadGET/report-runs/{run_id}/
get-reportsreadGET/reports/{id}/
get-reports-available-filtersreadGET/reports/{report_id}/available-filters/
list-sandboxesreadGET/sandboxes/
create-sandboxesadmin, writePOST/sandboxes/
delete-sandboxesadmin, deleteDELETE/sandboxes/{id}/
get-sandboxesreadGET/sandboxes/{id}/
developer_sandbox_entry_roles-sandboxesreadGET/sandboxes/{id}/developer-sandbox-entry-roles/
list-scheduled-job-assignmentsreadGET/scheduled-job-assignments/
delete-scheduled-job-assignmentsdelete, paymentDELETE/scheduled-job-assignments/{id}/
get-scheduled-job-assignmentsreadGET/scheduled-job-assignments/{id}/
list-schedulesreadGET/schedules/
create-scheduleswritePOST/schedules/
get-schedulesreadGET/schedules/{id}/
update-scheduleswritePATCH/schedules/{id}/
list-shift-inputsreadGET/shift-inputs/
create-shift-inputswritePOST/shift-inputs/
delete-shift-inputsdeleteDELETE/shift-inputs/{id}/
get-shift-inputsreadGET/shift-inputs/{id}/
update-shift-inputswritePATCH/shift-inputs/{id}/
list-shiftassignmentsreadGET/shiftassignments/
create-shiftassignmentssend, writePOST/shiftassignments/
get-shiftassignmentsreadGET/shiftassignments/{id}/
update-shiftassignmentssend, writePATCH/shiftassignments/{id}/
update-shiftassignments-customfieldswritePATCH/shiftassignments/{id}/customfields/
list-sitesreadGET/sites/
create-sitesadmin, writePOST/sites/
upload-batches-presign-sitesadmin, writePOST/sites/upload-batches/presign/
delete-sitesadmin, deleteDELETE/sites/{api_name}/
get-sitesreadGET/sites/{api_name}/
update-sitesadmin, writePATCH/sites/{api_name}/
file-operations-sitesadmin, writePOST/sites/{api_name}/file-operations/
files-sitesreadGET/sites/{api_name}/files/
list-software-deploymentsreadGET/software-deployments/
create-software-deploymentsadmin, writePOST/software-deployments/
delete-software-deploymentsadmin, deleteDELETE/software-deployments/{id}/
get-software-deploymentsreadGET/software-deployments/{id}/
update-software-deploymentsadmin, writePATCH/software-deployments/{id}/
list-sso-mereadGET/sso-me/
list-supergroupsreadGET/supergroups/
list-supergroups/(group-id)/exclusion-membersreadGET/supergroups/{group_id}/exclusion-members/
update-supergroups/(group_id)/exclusion-membersadmin, writePATCH/supergroups/{group_id}/exclusion-members/
list-supergroups/(group-id)/inclusion-membersreadGET/supergroups/{group_id}/inclusion-members/
update-supergroups/(group_id)/inclusion-membersadmin, writePATCH/supergroups/{group_id}/inclusion-members/
list-supergroups/(group-id)/membersreadGET/supergroups/{group_id}/members/
get-supergroupsreadGET/supergroups/{id}/
list-teamsreadGET/teams/
create-teamsadmin, writePOST/teams/
delete-teamsadmin, deleteDELETE/teams/{id}/
get-teamsreadGET/teams/{id}/
update-teamsadmin, writePATCH/teams/{id}/
list-time-cardsreadGET/time-cards/
get-time-cardsreadGET/time-cards/{id}/
list-time-entriesreadGET/time-entries/
create-time-entriespayment, writePOST/time-entries/
delete-time-entriesdelete, paymentDELETE/time-entries/{id}/
get-time-entriesreadGET/time-entries/{id}/
update-time-entriespayment, writePATCH/time-entries/{id}/
list-titlesreadGET/titles/
create-titlesadmin, writePOST/titles/
delete-titlesadmin, deleteDELETE/titles/{id}/
get-titlesreadGET/titles/{id}/
update-titlesadmin, writePATCH/titles/{id}/
list-tracksreadGET/tracks/
create-tracksadmin, writePOST/tracks/
delete-tracksadmin, deleteDELETE/tracks/{id}/
get-tracksreadGET/tracks/{id}/
update-tracksadmin, writePATCH/tracks/{id}/
list-unassignedshiftsreadGET/unassignedshifts/
create-unassignedshiftssend, writePOST/unassignedshifts/
get-unassignedshiftsreadGET/unassignedshifts/{id}/
update-unassignedshiftssend, writePATCH/unassignedshifts/{id}/
assign-unassignedshiftssend, writePOST/unassignedshifts/{id}/assign/
update-unassignedshifts-customfieldswritePATCH/unassignedshifts/{id}/customfields/
list-usersreadGET/users/
get-usersreadGET/users/{id}/
list-variable-compensation-payout-labelsreadGET/variable-compensation-payout-labels/
create-variable-compensation-payout-labelsadmin, writePOST/variable-compensation-payout-labels/
get-variable-compensation-payout-labelsreadGET/variable-compensation-payout-labels/{id}/
update-variable-compensation-payout-labelsadmin, writePATCH/variable-compensation-payout-labels/{id}/
list-variable-compensation-payout-typesreadGET/variable-compensation-payout-types/
create-variable-compensation-payout-typesadmin, writePOST/variable-compensation-payout-types/
delete-variable-compensation-payout-typesadmin, deleteDELETE/variable-compensation-payout-types/{id}/
get-variable-compensation-payout-typesreadGET/variable-compensation-payout-types/{id}/
update-variable-compensation-payout-typesadmin, writePATCH/variable-compensation-payout-types/{id}/
create-variable-compensation-payout-writespayment, writePOST/variable-compensation-payout-writes/
list-variable-compensation-payoutsreadGET/variable-compensation-payouts/
create-variable-compensation-payoutspayment, writePOST/variable-compensation-payouts/
get-variable-compensation-payoutsreadGET/variable-compensation-payouts/{id}/
list-work-locationsreadGET/work-locations/
create-work-locationsadmin, writePOST/work-locations/
delete-work-locationsadmin, deleteDELETE/work-locations/{id}/
get-work-locationsreadGET/work-locations/{id}/
update-work-locationsadmin, writePATCH/work-locations/{id}/
list-worker-change-fieldsreadGET/worker-change-fields/
list-worker-changesreadGET/worker-changes/
get-worker-changesreadGET/worker-changes/{id}/
list-worker-time-splitsreadGET/worker-time-splits/
create-worker-time-splitspayment, writePOST/worker-time-splits/
delete-worker-time-splitsdelete, paymentDELETE/worker-time-splits/{id}/
get-worker-time-splitsreadGET/worker-time-splits/{id}/
update-worker-time-splitspayment, writePATCH/worker-time-splits/{id}/
list-workersreadGET/workers/
get-workersreadGET/workers/{id}/
workflow-action-executionssend, writePOST/workflow-action-executions/
list-workflowsreadGET/workflows/
create-workflowsadmin, writePOST/workflows/
delete-workflowsadmin, deleteDELETE/workflows/{id}/
get-workflowsreadGET/workflows/{id}/
update-workflowsadmin, writePATCH/workflows/{id}/

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.