Reference
Rippling
Connect a Rippling company API token to Alter Vault for governed access to HR, IT, and payroll data
Overview
Section titled “Overview”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.
| Property | Value |
|---|---|
| Provider ID | rippling |
| Category | HR |
| Credential Type | API Token |
| API host | rest.ripplingapis.com |
Step 1: Create a Rippling API token
Section titled “Step 1: Create a Rippling API token”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.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”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.
Using in Code
Section titled “Using in Code”response = await alter_app.request( HttpMethod.GET, "https://rest.ripplingapis.com/workers/", grant_id="YOUR_GRANT_ID", query_params={"limit": "50"},)Policy
Section titled “Policy”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:
| Family | Rippling operations it covers |
|---|---|
read | Every GET, plus the read-only POST queries (custom-object record queries, metadata extract and validate) |
write | Every create and update |
delete | Every DELETE, plus bulk deletion of custom-object records |
payment | Writes 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) |
send | Writes 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 |
admin | Org 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
paymentfamily, so no payroll run or payout happens without a person approving it. - Deny the
deletefamily on agent grants. - Restrict a grant to
GETon/workers/*for a read-only reporting agent. - Redact a free-text body field such as
reason_for_leavebefore 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 withRetry-Afterbeyond 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.
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
list-activity-log | read | GET | /activity-log/ |
get-activity-log | read | GET | /activity-log/{id}/ |
list-agents | read | GET | /agents/ |
create-agents | admin, write | POST | /agents/ |
create-agent-session | send, write | POST | /agents/sessions/ |
get-agent-session | read | GET | /agents/sessions/{session_id}/ |
list-agent-session-events | read | GET | /agents/sessions/{session_id}/events/ |
append-agent-session-message | send, write | POST | /agents/sessions/{session_id}/messages/ |
capture-agent-session-resume-state | write | POST | /agents/sessions/{session_id}/resume-state/ |
delete-agent | admin, delete | DELETE | /agents/{agent_id}/ |
get-agent | read | GET | /agents/{agent_id}/ |
update-agent | admin, write | PATCH | /agents/{agent_id}/ |
list-agent-deployments | read | GET | /agents/{agent_id}/deployments/ |
create-agent-deployment | admin, write | POST | /agents/{agent_id}/deployments/ |
get-agent-deployment | read | GET | /agents/{agent_id}/deployments/{deployment_id}/ |
list-agent-sessions | read | GET | /agents/{agent_id}/sessions/ |
list-agent-source-revisions | read | GET | /agents/{agent_id}/source-revisions/ |
create-agent-source-revision | admin, write | POST | /agents/{agent_id}/source-revisions/ |
get-agent-source-revision | read | GET | /agents/{agent_id}/source-revisions/{source_revision_id}/ |
list-app-users | read | GET | /app-users/ |
get-app-users | read | GET | /app-users/{id}/ |
list-background-check-candidates | read | GET | /background-check-candidates/ |
create-background-check-candidates | send, write | POST | /background-check-candidates/ |
delete-background-check-candidates | delete | DELETE | /background-check-candidates/{id}/ |
get-background-check-candidates | read | GET | /background-check-candidates/{id}/ |
update-background-check-candidates | send, write | PATCH | /background-check-candidates/{id}/ |
list-break-policies | read | GET | /break-policies/ |
get-break-policies | read | GET | /break-policies/{id}/ |
list-break-types | read | GET | /break-types/ |
get-break-types | read | GET | /break-types/{id}/ |
list-business-partner-groups | read | GET | /business-partner-groups/ |
create-business-partner-groups | admin, write | POST | /business-partner-groups/ |
delete-business-partner-groups | admin, delete | DELETE | /business-partner-groups/{id}/ |
get-business-partner-groups | read | GET | /business-partner-groups/{id}/ |
list-business-partners | read | GET | /business-partners/ |
create-business-partners | admin, write | POST | /business-partners/ |
delete-business-partners | admin, delete | DELETE | /business-partners/{id}/ |
get-business-partners | read | GET | /business-partners/{id}/ |
list-business-structure-paths | read | GET | /business-structure-paths/ |
create-business-structure-paths | admin, write | POST | /business-structure-paths/ |
delete-business-structure-paths | admin, delete | DELETE | /business-structure-paths/{id}/ |
get-business-structure-paths | read | GET | /business-structure-paths/{id}/ |
list-candidate-applications | read | GET | /candidate-applications/ |
list-candidates | read | GET | /candidates/ |
list-companies | read | GET | /companies/ |
list-company-legal-entities | read | GET | /company-legal-entities/ |
get-company-legal-entities | read | GET | /company-legal-entities/{id}/ |
list-company-legal-entity-workers | read | GET | /company-legal-entity-workers/ |
get-company-legal-entity-workers | read | GET | /company-legal-entity-workers/{id}/ |
list-compensation-bands-details | read | GET | /compensation-bands-details/ |
get-compensation-bands-details | read | GET | /compensation-bands-details/{id}/ |
list-compensations | read | GET | /compensations/ |
get-compensations | read | GET | /compensations/{id}/ |
list-custom-apps | read | GET | /custom-apps/ |
create-custom-apps | admin, write | POST | /custom-apps/ |
delete-custom-apps | admin, delete | DELETE | /custom-apps/{id}/ |
get-custom-apps | read | GET | /custom-apps/{id}/ |
update-custom-apps | admin, write | PATCH | /custom-apps/{id}/ |
list-custom-fields | read | GET | /custom-fields/ |
list-custom-objects | read | GET | /custom-objects/ |
create-custom-objects | admin, write | POST | /custom-objects/ |
delete-custom-objects | admin, delete | DELETE | /custom-objects/{custom_object_api_name}/ |
get-custom-objects | read | GET | /custom-objects/{custom_object_api_name}/ |
update-custom-objects | admin, write | PATCH | /custom-objects/{custom_object_api_name}/ |
list-custom-objects/(custom-object-api-name)/fields | read | GET | /custom-objects/{custom_object_api_name}/fields/ |
create-custom-objects/(custom-object-api-name)/fields | admin, write | POST | /custom-objects/{custom_object_api_name}/fields/ |
delete-custom-objects/(custom-object-api-name)/fields | admin, delete | DELETE | /custom-objects/{custom_object_api_name}/fields/{field_api_name}/ |
get-custom-objects/(custom-object-api-name)/fields | read | GET | /custom-objects/{custom_object_api_name}/fields/{field_api_name}/ |
update-custom-objects/(custom-object-api-name)/fields | admin, write | PATCH | /custom-objects/{custom_object_api_name}/fields/{field_api_name}/ |
list-custom-objects/(custom-object-api-name)/records | read | GET | /custom-objects/{custom_object_api_name}/records/ |
create-custom-objects/(custom-object-api-name)/records | write | POST | /custom-objects/{custom_object_api_name}/records/ |
bulk-delete-custom-objects/(custom-object-api-name)/records | delete | POST | /custom-objects/{custom_object_api_name}/records/bulk-delete/ |
bulk-update-custom-objects/(custom-object-api-name)/records | write | PATCH | /custom-objects/{custom_object_api_name}/records/bulk/ |
bulk-create-custom-objects/(custom-object-api-name)/records | write | POST | /custom-objects/{custom_object_api_name}/records/bulk/ |
get-custom-objects/(custom-object-api-name)/records-by-external-id | read | GET | /custom-objects/{custom_object_api_name}/records/external_id/{external_id}/ |
list-by-query-custom-objects/(custom-object-api-name)/records | read | POST | /custom-objects/{custom_object_api_name}/records/query/ |
delete-custom-objects/(custom-object-api-name)/records | delete | DELETE | /custom-objects/{custom_object_api_name}/records/{codr_id}/ |
get-custom-objects/(custom-object-api-name)/records | read | GET | /custom-objects/{custom_object_api_name}/records/{codr_id}/ |
update-custom-objects/(custom-object-api-name)/records | write | PATCH | /custom-objects/{custom_object_api_name}/records/{codr_id}/ |
list-custom-pages | read | GET | /custom-pages/ |
create-custom-pages | admin, write | POST | /custom-pages/ |
delete-custom-pages | admin, delete | DELETE | /custom-pages/{id}/ |
get-custom-pages | read | GET | /custom-pages/{id}/ |
update-custom-pages | admin, write | PATCH | /custom-pages/{id}/ |
list-custom-settings | read | GET | /custom-settings/ |
create-custom-settings | admin, write | POST | /custom-settings/ |
delete-custom-settings | admin, delete | DELETE | /custom-settings/{api_name}/ |
get-custom-settings | read | GET | /custom-settings/{api_name}/ |
update-custom-settings | admin, write | PATCH | /custom-settings/{api_name}/ |
list-departments | read | GET | /departments/ |
create-departments | admin, write | POST | /departments/ |
get-departments | read | GET | /departments/{id}/ |
update-departments | admin, write | PATCH | /departments/{id}/ |
list-developer-program-application | read | GET | /developer-program-application/ |
create-developer-program-application | admin, write | POST | /developer-program-application/ |
list-developer-users | read | GET | /developer-users/ |
list-device-orders | read | GET | /device-orders/ |
get-device-orders | read | GET | /device-orders/{id}/ |
list-devices | read | GET | /devices/ |
get-devices | read | GET | /devices/{id}/ |
create-draft-hires | write | POST | /draft-hires/ |
create-draft-transitions | write | POST | /draft-transitions/ |
get-draft-transitions | read | GET | /draft-transitions/{id}/ |
list-earning-types | read | GET | /earning-types/ |
list-earnings-inputs | read | GET | /earnings-inputs/ |
create-earnings-inputs | payment, write | POST | /earnings-inputs/ |
delete-earnings-inputs | delete, payment | DELETE | /earnings-inputs/{id}/ |
create-employee-documents | send, write | POST | /employee-documents/ |
list-employment-types | read | GET | /employment-types/ |
get-employment-types | read | GET | /employment-types/{id}/ |
list-entitlements | read | GET | /entitlements/ |
create-files | write | POST | /files/ |
get-files | read | GET | /files/{id}/ |
list-functions | read | GET | /functions/ |
create-functions | admin, write | POST | /functions/ |
get-functions | read | GET | /functions/{function_api_name}/ |
update-functions | admin, write | PATCH | /functions/{function_api_name}/ |
list-functions/(function-api-name)/deployments | read | GET | /functions/{function_api_name}/deployments/ |
create-functions/(function-api-name)/deployments | admin, write | POST | /functions/{function_api_name}/deployments/ |
get-functions/(function-api-name)/deployments | read | GET | /functions/{function_api_name}/deployments/{deployment_id}/ |
list-functions/(function-api-name)/deployments/(deployment-id)/logs | read | GET | /functions/{function_api_name}/deployments/{deployment_id}/logs/ |
create-functions/(function-api-name)/dev_bundles | admin, write | POST | /functions/{function_api_name}/dev_bundles/ |
list-functions/(function-api-name)/executions | read | GET | /functions/{function_api_name}/executions/ |
create-functions/(function-api-name)/executions | send, write | POST | /functions/{function_api_name}/executions/ |
get-functions/(function-api-name)/executions | read | GET | /functions/{function_api_name}/executions/{execution_id}/ |
list-functions/(function-api-name)/executions/(execution-id)/logs | read | GET | /functions/{function_api_name}/executions/{execution_id}/logs/ |
list-headcount-positions | read | GET | /headcount-positions/ |
get-headcount-positions | read | GET | /headcount-positions/{id}/ |
list-headcount-priorities | read | GET | /headcount-priorities/ |
get-headcount-priorities | read | GET | /headcount-priorities/{id}/ |
get-hire-requirements | read | GET | /hire-requirements/ |
create-hires | payment, send, write | POST | /hires/ |
list-job-assignments | read | GET | /job-assignments/ |
create-job-assignments | payment, write | POST | /job-assignments/ |
delete-job-assignments | delete, payment | DELETE | /job-assignments/{id}/ |
get-job-assignments | read | GET | /job-assignments/{id}/ |
update-job-assignments | payment, write | PATCH | /job-assignments/{id}/ |
list-job-assignments/{job_assignment_id}/change-log | read | GET | /job-assignments/{job_assignment_id}/change-log/ |
list-job-codes | read | GET | /job-codes/ |
create-job-codes | admin, payment, write | POST | /job-codes/ |
delete-job-codes | admin, delete | DELETE | /job-codes/{id}/ |
get-job-codes | read | GET | /job-codes/{id}/ |
update-job-codes | admin, payment, write | PATCH | /job-codes/{id}/ |
list-job-codes/{job_code_id}/change-log | read | GET | /job-codes/{job_code_id}/change-log/ |
list-job-dimensions | read | GET | /job-dimensions/ |
create-job-dimensions | admin, write | POST | /job-dimensions/ |
delete-job-dimensions | admin, delete | DELETE | /job-dimensions/{id}/ |
get-job-dimensions | read | GET | /job-dimensions/{id}/ |
update-job-dimensions | admin, write | PATCH | /job-dimensions/{id}/ |
list-job-functions | read | GET | /job-functions/ |
get-job-functions | read | GET | /job-functions/{id}/ |
list-job-pay-rate-exceptions | read | GET | /job-pay-rate-exceptions/ |
get-job-pay-rate-exceptions | read | GET | /job-pay-rate-exceptions/{id}/ |
list-job-pay-rate-exceptions/{job_pay_rate_exception_id}/change-log | read | GET | /job-pay-rate-exceptions/{job_pay_rate_exception_id}/change-log/ |
create-job-requisitions-write | write | POST | /job-requisitions-write/ |
list-job-requisitions | read | GET | /job-requisitions/ |
list-kiosk-badges | read | GET | /kiosk-badges/ |
create-kiosk-badges | admin, write | POST | /kiosk-badges/ |
delete-kiosk-badges | admin, delete | DELETE | /kiosk-badges/{id}/ |
get-kiosk-badges | read | GET | /kiosk-badges/{id}/ |
update-kiosk-badges | admin, write | PATCH | /kiosk-badges/{id}/ |
list-leave-accruals | read | GET | /leave-accruals/ |
create-leave-accruals | payment, write | POST | /leave-accruals/ |
get-leave-accruals | read | GET | /leave-accruals/{id}/ |
list-leave-balances | read | GET | /leave-balances/ |
get-leave-balances | read | GET | /leave-balances/{id}/ |
create-leave-program-evaluations | write | POST | /leave-program-evaluations/ |
list-leave-requests | read | GET | /leave-requests/ |
create-leave-requests | send, write | POST | /leave-requests/ |
get-leave-requests | read | GET | /leave-requests/{id}/ |
update-leave-requests | send, write | PATCH | /leave-requests/{id}/ |
list-leave-types | read | GET | /leave-types/ |
get-leave-types | read | GET | /leave-types/{id}/ |
list-legal-entities | read | GET | /legal-entities/ |
get-legal-entities | read | GET | /legal-entities/{id}/ |
list-levels | read | GET | /levels/ |
create-levels | admin, write | POST | /levels/ |
delete-levels | admin, delete | DELETE | /levels/{id}/ |
get-levels | read | GET | /levels/{id}/ |
update-levels | admin, write | PATCH | /levels/{id}/ |
list-listing-submissions | read | GET | /listing-submissions/ |
get-listing-submissions | read | GET | /listing-submissions/{id}/ |
list-listing-transitions | read | GET | /listing-transitions/ |
list-listing | read | GET | /listing/ |
create-listing | admin, write | POST | /listing/ |
get-listing | read | GET | /listing/{id}/ |
update-listing | admin, write | PATCH | /listing/{id}/ |
delist-listing | admin, write | POST | /listing/{listing_id}/delist/ |
publish-listing | admin, write | POST | /listing/{listing_id}/publish/ |
resubmit-listing | admin, write | POST | /listing/{listing_id}/resubmit/ |
submit-listing | admin, write | POST | /listing/{listing_id}/submit/ |
withdraw-listing | admin, write | POST | /listing/{listing_id}/withdraw/ |
list-location-factors | read | GET | /location-factors/ |
get-location-factors | read | GET | /location-factors/{id}/ |
deploy-metadata-components | admin, write | POST | /metadata/deploy/ |
create-metadata-deployment-run | admin, write | POST | /metadata/deployment-runs/ |
get-metadata-deployment-run | read | GET | /metadata/deployment-runs/{run_id}/ |
extract-metadata-components | read | GET | /metadata/extract/ |
extract-metadata-components-by-identifiers | read | POST | /metadata/extract/ |
get-metadata-schema | read | GET | /metadata/schema/ |
list-metadata-types | read | GET | /metadata/types/ |
validate-metadata-components | read | POST | /metadata/validate/ |
create-metadata-validation-run | write | POST | /metadata/validation-runs/ |
get-metadata-validation-run | read | GET | /metadata/validation-runs/{run_id}/ |
list-object-categories | read | GET | /object-categories/ |
create-object-categories | admin, write | POST | /object-categories/ |
delete-object-categories | admin, delete | DELETE | /object-categories/{id}/ |
get-object-categories | read | GET | /object-categories/{id}/ |
update-object-categories | admin, write | PATCH | /object-categories/{id}/ |
install-package-installs | admin, write | POST | /package-installs/ |
get-package-installs | read | GET | /package-installs/{tracker_id}/ |
install-package-managed-installs | admin, write | POST | /package-managed-installs/ |
get-package-managed-installs | read | GET | /package-managed-installs/{install_id}/ |
create-package-sandbox-links | admin, write | POST | /package-sandbox-links/ |
get-package-sandbox-links | read | GET | /package-sandbox-links/{tracker_id}/ |
uninstall-package-uninstalls | admin, write | POST | /package-uninstalls/ |
get-package-uninstalls | read | GET | /package-uninstalls/{tracker_id}/ |
upgrade-package-upgrades | admin, write | POST | /package-upgrades/ |
get-package-upgrades | read | GET | /package-upgrades/{tracker_id}/ |
update-package-version-component-updates | admin, write | POST | /package-version-component-updates/ |
get-package-version-component-updates | read | GET | /package-version-component-updates/{tracker_id}/ |
get-package-versions | read | GET | /package-versions/{version_id}/ |
update-package-versions | admin, write | PATCH | /package-versions/{version_id}/ |
publish-package-versions | admin, write | POST | /package-versions/{version_id}/publish/ |
list-packages | read | GET | /packages/ |
create-packages | admin, write | POST | /packages/ |
delete-packages | admin, delete | DELETE | /packages/{package_key}/ |
get-packages | read | GET | /packages/{package_key}/ |
update-packages | admin, write | PATCH | /packages/{package_key}/ |
list-available-package-upgrades | read | GET | /packages/{package_key}/available-upgrades/ |
create-next-package-versions | admin, write | POST | /packages/{package_key}/next-versions/ |
list-package-versions | read | GET | /packages/{package_key}/versions/ |
create-package-versions | admin, write | POST | /packages/{package_key}/versions/ |
create-payroll-payment-mode-changes | payment, write | POST | /payroll-payment-mode-changes/ |
list-payroll-runs | read | GET | /payroll-runs/ |
create-payroll-runs/off-cycle | payment, write | POST | /payroll-runs/off-cycle/ |
get-payroll-runs | read | GET | /payroll-runs/{id}/ |
list-worker-payroll-records | read | GET | /payroll-runs/{run_id}/worker-payroll-records/ |
list-platform-capabilities | read | GET | /platform-capabilities/ |
v1.get-app-app_matching_users | read | GET | /platform/api/app_detail/app_matching_users |
v1.get-companies | read | GET | /platform/api/companies/current |
v1.get-company_activity | read | GET | /platform/api/company_activity |
v1.get-company_leave_types | read | GET | /platform/api/company_leave_types |
v1.get-custom_fields | read | GET | /platform/api/custom_fields |
v1.get-departments | read | GET | /platform/api/departments |
v1.get-employees | read | GET | /platform/api/employees |
v1.get-employees-include_terminated | read | GET | /platform/api/employees/include_terminated |
v1.get-employees-employeeId | read | GET | /platform/api/employees/{employeeId} |
v1.get-groups | read | GET | /platform/api/groups |
v1.post-groups | admin, write | POST | /platform/api/groups |
v1.delete-groups-groupId | admin, delete | DELETE | /platform/api/groups/{groupId} |
v1.get-groups-groupId | read | GET | /platform/api/groups/{groupId} |
v1.patch-groups-groupId | admin, write | PATCH | /platform/api/groups/{groupId} |
v1.put-groups-groupId | admin, write | PUT | /platform/api/groups/{groupId} |
v1.get-leave_balances | read | GET | /platform/api/leave_balances |
v1.get-leave_balance | read | GET | /platform/api/leave_balances/{role} |
v1.get-leave_requests | read | GET | /platform/api/leave_requests |
v1.post-leave_requests | send, write | POST | /platform/api/leave_requests |
v1.patch-leave_requests-leaveRequestId | send, write | PATCH | /platform/api/leave_requests/{id} |
v1.cancel-leave_requests | send, write | POST | /platform/api/leave_requests/{id}/cancel |
v1.process-leave_requests | send, write | POST | /platform/api/leave_requests/{id}/process |
v1.get-levels | read | GET | /platform/api/levels |
v1.post-mark_app_installed | write | POST | /platform/api/mark_app_installed |
v1.get-me | read | GET | /platform/api/me |
v1.get-saml-idp_metadata | read | GET | /platform/api/saml/idp_metadata |
v1.get-teams | read | GET | /platform/api/teams |
v1.get-work_locations | read | GET | /platform/api/work_locations |
trigger-report-runs | write | POST | /report-runs/ |
get-report-runs | read | GET | /report-runs/{run_id}/ |
get-reports | read | GET | /reports/{id}/ |
get-reports-available-filters | read | GET | /reports/{report_id}/available-filters/ |
list-sandboxes | read | GET | /sandboxes/ |
create-sandboxes | admin, write | POST | /sandboxes/ |
delete-sandboxes | admin, delete | DELETE | /sandboxes/{id}/ |
get-sandboxes | read | GET | /sandboxes/{id}/ |
developer_sandbox_entry_roles-sandboxes | read | GET | /sandboxes/{id}/developer-sandbox-entry-roles/ |
list-scheduled-job-assignments | read | GET | /scheduled-job-assignments/ |
delete-scheduled-job-assignments | delete, payment | DELETE | /scheduled-job-assignments/{id}/ |
get-scheduled-job-assignments | read | GET | /scheduled-job-assignments/{id}/ |
list-schedules | read | GET | /schedules/ |
create-schedules | write | POST | /schedules/ |
get-schedules | read | GET | /schedules/{id}/ |
update-schedules | write | PATCH | /schedules/{id}/ |
list-shift-inputs | read | GET | /shift-inputs/ |
create-shift-inputs | write | POST | /shift-inputs/ |
delete-shift-inputs | delete | DELETE | /shift-inputs/{id}/ |
get-shift-inputs | read | GET | /shift-inputs/{id}/ |
update-shift-inputs | write | PATCH | /shift-inputs/{id}/ |
list-shiftassignments | read | GET | /shiftassignments/ |
create-shiftassignments | send, write | POST | /shiftassignments/ |
get-shiftassignments | read | GET | /shiftassignments/{id}/ |
update-shiftassignments | send, write | PATCH | /shiftassignments/{id}/ |
update-shiftassignments-customfields | write | PATCH | /shiftassignments/{id}/customfields/ |
list-sites | read | GET | /sites/ |
create-sites | admin, write | POST | /sites/ |
upload-batches-presign-sites | admin, write | POST | /sites/upload-batches/presign/ |
delete-sites | admin, delete | DELETE | /sites/{api_name}/ |
get-sites | read | GET | /sites/{api_name}/ |
update-sites | admin, write | PATCH | /sites/{api_name}/ |
file-operations-sites | admin, write | POST | /sites/{api_name}/file-operations/ |
files-sites | read | GET | /sites/{api_name}/files/ |
list-software-deployments | read | GET | /software-deployments/ |
create-software-deployments | admin, write | POST | /software-deployments/ |
delete-software-deployments | admin, delete | DELETE | /software-deployments/{id}/ |
get-software-deployments | read | GET | /software-deployments/{id}/ |
update-software-deployments | admin, write | PATCH | /software-deployments/{id}/ |
list-sso-me | read | GET | /sso-me/ |
list-supergroups | read | GET | /supergroups/ |
list-supergroups/(group-id)/exclusion-members | read | GET | /supergroups/{group_id}/exclusion-members/ |
update-supergroups/(group_id)/exclusion-members | admin, write | PATCH | /supergroups/{group_id}/exclusion-members/ |
list-supergroups/(group-id)/inclusion-members | read | GET | /supergroups/{group_id}/inclusion-members/ |
update-supergroups/(group_id)/inclusion-members | admin, write | PATCH | /supergroups/{group_id}/inclusion-members/ |
list-supergroups/(group-id)/members | read | GET | /supergroups/{group_id}/members/ |
get-supergroups | read | GET | /supergroups/{id}/ |
list-teams | read | GET | /teams/ |
create-teams | admin, write | POST | /teams/ |
delete-teams | admin, delete | DELETE | /teams/{id}/ |
get-teams | read | GET | /teams/{id}/ |
update-teams | admin, write | PATCH | /teams/{id}/ |
list-time-cards | read | GET | /time-cards/ |
get-time-cards | read | GET | /time-cards/{id}/ |
list-time-entries | read | GET | /time-entries/ |
create-time-entries | payment, write | POST | /time-entries/ |
delete-time-entries | delete, payment | DELETE | /time-entries/{id}/ |
get-time-entries | read | GET | /time-entries/{id}/ |
update-time-entries | payment, write | PATCH | /time-entries/{id}/ |
list-titles | read | GET | /titles/ |
create-titles | admin, write | POST | /titles/ |
delete-titles | admin, delete | DELETE | /titles/{id}/ |
get-titles | read | GET | /titles/{id}/ |
update-titles | admin, write | PATCH | /titles/{id}/ |
list-tracks | read | GET | /tracks/ |
create-tracks | admin, write | POST | /tracks/ |
delete-tracks | admin, delete | DELETE | /tracks/{id}/ |
get-tracks | read | GET | /tracks/{id}/ |
update-tracks | admin, write | PATCH | /tracks/{id}/ |
list-unassignedshifts | read | GET | /unassignedshifts/ |
create-unassignedshifts | send, write | POST | /unassignedshifts/ |
get-unassignedshifts | read | GET | /unassignedshifts/{id}/ |
update-unassignedshifts | send, write | PATCH | /unassignedshifts/{id}/ |
assign-unassignedshifts | send, write | POST | /unassignedshifts/{id}/assign/ |
update-unassignedshifts-customfields | write | PATCH | /unassignedshifts/{id}/customfields/ |
list-users | read | GET | /users/ |
get-users | read | GET | /users/{id}/ |
list-variable-compensation-payout-labels | read | GET | /variable-compensation-payout-labels/ |
create-variable-compensation-payout-labels | admin, write | POST | /variable-compensation-payout-labels/ |
get-variable-compensation-payout-labels | read | GET | /variable-compensation-payout-labels/{id}/ |
update-variable-compensation-payout-labels | admin, write | PATCH | /variable-compensation-payout-labels/{id}/ |
list-variable-compensation-payout-types | read | GET | /variable-compensation-payout-types/ |
create-variable-compensation-payout-types | admin, write | POST | /variable-compensation-payout-types/ |
delete-variable-compensation-payout-types | admin, delete | DELETE | /variable-compensation-payout-types/{id}/ |
get-variable-compensation-payout-types | read | GET | /variable-compensation-payout-types/{id}/ |
update-variable-compensation-payout-types | admin, write | PATCH | /variable-compensation-payout-types/{id}/ |
create-variable-compensation-payout-writes | payment, write | POST | /variable-compensation-payout-writes/ |
list-variable-compensation-payouts | read | GET | /variable-compensation-payouts/ |
create-variable-compensation-payouts | payment, write | POST | /variable-compensation-payouts/ |
get-variable-compensation-payouts | read | GET | /variable-compensation-payouts/{id}/ |
list-work-locations | read | GET | /work-locations/ |
create-work-locations | admin, write | POST | /work-locations/ |
delete-work-locations | admin, delete | DELETE | /work-locations/{id}/ |
get-work-locations | read | GET | /work-locations/{id}/ |
update-work-locations | admin, write | PATCH | /work-locations/{id}/ |
list-worker-change-fields | read | GET | /worker-change-fields/ |
list-worker-changes | read | GET | /worker-changes/ |
get-worker-changes | read | GET | /worker-changes/{id}/ |
list-worker-time-splits | read | GET | /worker-time-splits/ |
create-worker-time-splits | payment, write | POST | /worker-time-splits/ |
delete-worker-time-splits | delete, payment | DELETE | /worker-time-splits/{id}/ |
get-worker-time-splits | read | GET | /worker-time-splits/{id}/ |
update-worker-time-splits | payment, write | PATCH | /worker-time-splits/{id}/ |
list-workers | read | GET | /workers/ |
get-workers | read | GET | /workers/{id}/ |
workflow-action-executions | send, write | POST | /workflow-action-executions/ |
list-workflows | read | GET | /workflows/ |
create-workflows | admin, write | POST | /workflows/ |
delete-workflows | admin, delete | DELETE | /workflows/{id}/ |
get-workflows | read | GET | /workflows/{id}/ |
update-workflows | admin, write | PATCH | /workflows/{id}/ |