Reference
Rippling
Set up Rippling OAuth through a Rippling App Shop listing for HR, IT, and payroll data
Overview
Section titled “Overview”Connect Rippling companies through a Rippling App Shop listing. Each connection is one Rippling company: an admin of that company installs the listing, and Alter holds and refreshes the resulting tokens so agents can call Rippling’s API without ever seeing them.
To connect a single Rippling company with its own API token instead, see Rippling (API token).
| Property | Value |
|---|---|
| Provider ID | rippling |
| Category | HR |
| PKCE | Supported (S256 — Alter sends it; Rippling’s OAuth discovery advertises S256) |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
| API hosts | rest.ripplingapis.com (V2 REST API), api.rippling.com (legacy V1 Platform API) |
Step 1: Configure the Rippling listing
Section titled “Step 1: Configure the Rippling listing”Open the listing
Sign in to the Rippling Developer Portal and open the app listing. New partners apply through Rippling’s partner process.
Set the redirect URLs
Under Integration → Redirect URLs, add the Alter callback URL (from the Developer Portal) as an additional redirect URL. Set the Default Redirect URL to a route in the application that handles installs started in the App Shop (Step 3).
Add scopes
Under Integration → Scopes, add the scopes the integration needs, including companies.read: Alter reads the connected company with it. Rippling grants every listing scope to every install, so Alter does not send scopes in the authorization request; you declare the same set in Alter in Step 2.
Copy the App name
The App name is the last segment of the listing URL: app.rippling.com/app-shop/app/<App name>.
Copy the credentials
Under Integration → Credentials, copy the Client ID and Client Secret. Sandbox credentials install the listing into the test company; production credentials appear after Rippling approves the listing for beta. They are not interchangeable.
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 app.
Add the Rippling provider
Go to OAuth Providers > Add Provider > Rippling.
Enter the credentials and App name
Paste the Client ID, Client Secret, and App name. Use a separate Alter app for sandbox and production credentials: each listing version has its own App name and scopes.
Declare the listing's scopes
Select exactly the scopes configured on the listing. Alter records the declared scopes on every connection and blocks any proxied call to a cataloged operation that needs a scope outside them. Tokens retrieved directly carry every scope on the listing, so keep the declaration identical to the listing’s scope list.
Save
Click Save. Alter checks the Client ID and Client Secret with Rippling and rejects credentials Rippling does not accept. The App name cannot be verified this way, so the save reports it as not verified.
The same configuration is available from the CLI: alter providers create --provider rippling --provider-app-name <App name> --scopes companies.read,workers.read ....
Step 3: Handle installs that start in the App Shop
Section titled “Step 3: Handle installs that start in the App Shop”Rippling requires every listing to support installs that start from its App Shop. Those installs arrive at the Default Redirect URL with a code and a redirect_uri — Rippling’s own return URL — but without a session the application created. Hand them to an Alter Connect session, then send the admin back to Rippling:
from urllib.parse import urlparse
RIPPLING_RETURN_PREFIX = "/apps/PLATFORM/"
async def rippling_install(request, user): # Rippling sends the admin here from its App Shop. Keep Rippling's return # URL; the App Shop's own code is not used — Alter starts its own # authorization below. return_url = request.query_params["redirect_uri"] parsed = urlparse(return_url) if parsed.scheme != "https" or parsed.hostname != "app.rippling.com" or not parsed.path.startswith( RIPPLING_RETURN_PREFIX ): raise ValueError("unexpected Rippling return URL") request.session["rippling_return_url"] = return_url
session = await alter_app.create_connect_session( allowed_providers=["rippling"], user_token=user.alter_user_token, return_url="https://yourapp.example.com/rippling/connected", ) return redirect(session.connect_url)
async def rippling_connected(request): # Connect finished: return the admin to Rippling so the install completes there. return redirect(request.session.pop("rippling_return_url"))Installs the application starts itself need no extra handling: create a Connect session for rippling as for any provider.
The connected account
Section titled “The connected account”Each connection is one Rippling company. When a connection completes, Alter reads the company (GET /companies/ on the V2 API, falling back to the V1 Platform API for older listings) and records its id as the account identifier and its name as the display name. Once the connection is saved, Alter calls Rippling’s mark_app_installed, so the listing shows the company as connected. Reconnecting the same company reuses its connection.
If Rippling refuses both company reads (the installing user lacks the permissions, or the listing does not carry companies.read), the connection is not saved and the install is not marked complete: Rippling treats a refusal at install time as an unsuccessful install. An admin with sufficient permissions installs again, after companies.read is on the listing.
Scopes and reconnects
Section titled “Scopes and reconnects”Rippling grants the listing’s scopes to every install. When you add scopes to the listing, Rippling requires existing installs to authorize again: update the declared scopes in Alter, and every existing connection reports that it needs to reconnect until the admin re-authorizes.
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 the Rippling provider configuration. 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 (including scheduled job-assignment cancellations), leave accruals (including balance payouts), time entries and worker time splits, hires (which carry compensation), and the V1 candidate push into onboarding |
send | Writes that notify people or can act on their own: hires, the V1 candidate push, background-check candidates, employee documents, leave requests (including V1 approve and cancel), 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.
Rippling scopes are a second, separate check. Alter records the declared scopes on every connection and blocks any proxied call to a cataloged operation that needs a scope outside them. A grant can also be narrowed to some of the declared scopes — for example workers.read for one agent — and Alter refuses any call that needs a scope outside it with insufficient_scope, before the call reaches Rippling. Rippling’s field-level scopes (such as workers.sensitive.personal.read) decide which fields a read returns, so a grant narrowed without one that the declaration holds is refused that resource’s reads. A read that sets expand inlines related objects whose scopes Alter cannot classify, so a narrowed grant is refused it unless the delegation carries its own restriction rule for that path. Legacy V1 calls can be narrowed only where a V1 scope clearly names the resource; other V1 calls are refused for narrowed grants. Tokens retrieved directly carry every scope on the listing. A call must pass both policy and scopes.
Use alter policy simulate or Explain a request in the Developer Portal to see which operation, family, and scope a Rippling request classifies as. See Policies and Set policies.
What Alter handles for the listing
Section titled “What Alter handles for the listing”Rippling’s partner requirements ask every listing for an immediate API call after a connection and automatic token refresh; Alter does both. The application still owns the requirements that concern its own product: SSO, user management and provisioning, a webhook listener, the daily and manual employee sync, employee matching, and finishing App Shop installs in Rippling (Step 3).
- Access tokens last about 36 hours. Refresh tokens rotate on every refresh; Alter refreshes automatically.
- Rippling revokes a connection’s tokens when the installing admin leaves the company or the app is uninstalled. Alter marks the connection as needing reconnect on the next call made through Alter, including a call the SDK reports after making it directly; a token used outside the SDK is caught at the next refresh. Another admin re-installs to restore it.
- When a customer uninstalls, Rippling sends the application’s webhook listener a
company.deletedevent. Revoke the connection withalter_app.revoke_grant(grant_id)to remove Alter’s copy of the tokens. - 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 does not document the V1 Platform API’s limits. - New App Shop partners use the V2 REST API (
rest.ripplingapis.com). Listings created before November 2025 may still use the V1 Platform API (api.rippling.com/platform/api); both are covered below. - See the Rippling developer documentation for the full installation guide.
Available Scopes
Section titled “Available Scopes”The scopes a listing can carry, from Rippling’s permissions reference and V1 scopes guide.
V2 REST API
Section titled “V2 REST API”| Scope | Description |
|---|---|
activity-log.read | Read visible Activity Log events available to the authorized client |
activity-log.sensitive-data.read | Read sensitive Activity Log event data |
agent-deployments.read | Read agent deployments data available to the authorized client |
agent-deployments.read-write | Read and write agent deployments data available to the authorized client |
agent-sessions.read | Read agent sessions data available to the authorized client |
agent-sessions.read-write | Read and write agent sessions data available to the authorized client |
agent-source-revisions.read | Read agent source revisions data available to the authorized client |
agent-source-revisions.read-write | Read and write agent source revisions data available to the authorized client |
agents.read | Read agents data available to the authorized client |
agents.read-write | Read and write agents data available to the authorized client |
app-users.read | Read app users data available to the authorized client |
background-check-candidates.read | Read background check candidates data available to the authorized client |
background-check-candidates.read-write | Read and write background check candidates data available to the authorized client |
break-policies.read | Read break policies data available to the authorized client |
break-types.read | Read break types data available to the authorized client |
business-partner-groups.read | Read business partner groups data available to the authorized client |
business-partner-groups.read-write | Read and write business partner groups data available to the authorized client |
business-partners.read | Read business partners data available to the authorized client |
business-partners.read-write | Read and write business partners data available to the authorized client |
business-structure-paths.read | Read business-structure-paths data available to the authorized client |
business-structure-paths.read-write | Read and write business-structure-paths data available to the authorized client |
candidate-applications.read | Read candidate applications data available to the authorized client |
candidate-applications.read-write | Read and write candidate applications data available to the authorized client |
candidates.read | Read candidates data available to the authorized client |
companies.read | Read companies data available to the authorized client |
company-legal-entities.read | Read company legal entities data available to the authorized client |
company-legal-entity-workers.read | Read company-legal-entity-workers data available to the authorized client |
compensation-bands-details.read | Read compensation bands details data available to the authorized client |
compensations.read | Read compensations data available to the authorized client |
custom-apps.read | Required by Rippling operations: List CustomApp; Retrieve a specific CustomApp |
custom-apps.read-write | Required by Rippling operations: Create a new CustomApp; Delete a CustomApp; Update a CustomApp |
custom-fields.read | Read custom fields data available to the authorized client |
custom-object-records.read | Read custom object records data available to the authorized client |
custom-object-records.read-write | Read and write custom object records data available to the authorized client |
custom-object.read-write.owner | Required by Rippling operations: Bulk Create custom object records |
custom-objects.read | Read custom-objects data available to the authorized client |
custom-objects.read-write | Read and write custom-objects data available to the authorized client |
custom-objects.read-write.owner | Create new custom-objects, read and write custom-objects data owned by the authorized client |
custom-pages.read | Required by Rippling operations: List CustomPage; Retrieve a specific CustomPage |
custom-pages.read-write | Required by Rippling operations: Create a new CustomPage; Delete a CustomPage; Update a CustomPage |
custom-settings.read | Read Custom-settings data available to the authorized client |
custom-settings.read-write | Read and write Custom-settings data available to the authorized client |
departments.read | Read departments data available to the authorized client |
departments.read-write | Read and write departments data available to the authorized client |
developer-account.read | Read developer account |
developer-program-application.read | Read Developer Program application for an existing company |
developer-program-application.read-write | Create a Developer Program application for an existing company |
developer-users.read | List developer users |
device-orders.read | Read device orders data available to the authorized client |
devices.read | Read devices data available to the authorized client |
draft-hires.read | Read draft hires data available to the authorized client |
draft-hires.read-write | Read and write draft hires data available to the authorized client |
draft-transitions.read | Read draft transitions data available to the authorized client |
draft-transitions.read-write | Read and write draft transitions data available to the authorized client |
earning-types.read | Read earning-types data available to the authorized client |
earnings-inputs.read | Read earnings-inputs data available to the authorized client |
earnings-inputs.read-write | Read and write earnings-inputs data available to the authorized client |
employee-documents.read | Read employee documents data available to the authorized client |
employee-documents.read-write | Read and write employee documents data available to the authorized client |
employment-types.read | Read employment types data available to the authorized client |
entitlements.read | Read entitlements data available to the authorized client |
files.read | Read files data available to the authorized client |
files.read-write | Read and write files data available to the authorized client |
files:upload-url.read | Read file upload data available to the authorized client |
files:upload-url.write | Generate a presigned upload URL via File Upload |
function-executions.read | Read function executions data available to the authorized client |
function-executions.read-write | Read and write function executions data available to the authorized client |
function-executions.write | Write function executions data available to the authorized client |
functions.read | Read functions data available to the authorized client |
functions.read-write | Read and write functions data available to the authorized client |
headcount-positions.compensation.read | Read compensation data in headcount positions |
headcount-positions.read | Read headcount positions data available to the authorized client |
headcount-priorities.read | Read headcount priorities data available to the authorized client |
hire-requirements.read | Read hire requirements data available to the authorized client |
hires.read | Read hires data available to the authorized client |
hires.read-write | Read and write hires data available to the authorized client |
job-assignments.read | Read job assignments data available to the authorized client |
job-assignments.read-write | Read and write job assignments data available to the authorized client |
job-codes.read | Read job codes data available to the authorized client |
job-codes.read-write | Read and write job codes data available to the authorized client |
job-dimensions.read | Read job dimensions data available to the authorized client |
job-dimensions.read-write | Read and write job dimensions data available to the authorized client |
job-functions.read | Read job functions data available to the authorized client |
job-pay-rate-exceptions.read | Read job pay rate exceptions data available to the authorized client |
job-requisitions-write.read | Read job requisitions data available to the authorized client |
job-requisitions-write.read-write | Read and write job requisitions data available to the authorized client |
job-requisitions.read | Read job requisitions data available to the authorized client |
kiosk-badges.read | Read kiosk badges data available to the authorized client |
kiosk-badges.read-write | Read and write kiosk badges data available to the authorized client |
leave-accruals.read | Read leave accruals data available to the authorized client |
leave-accruals.read-write | Read and write leave accruals data available to the authorized client |
leave-balances.read | Read leave balances data available to the authorized client |
leave-program-evaluations.read | Read leave program evaluations data available to the authorized client |
leave-program-evaluations.read-write | Read and write leave program evaluations data available to the authorized client |
leave-requests.read | Read leave requests data available to the authorized client |
leave-requests.read-write | Read and write leave requests data available to the authorized client |
leave-types.read | Read leave types data available to the authorized client |
legal-entities.read | Read legal entities data available to the authorized client |
levels.read | Read levels data available to the authorized client |
levels.read-write | Read and write levels data available to the authorized client |
listing-submissions.read | Required by Rippling operations: List listing submission; Retrieve a specific listing submission |
listing-transitions.read | Required by Rippling operations: List listing transition |
listing.read | Required by Rippling operations: List listing; Retrieve a specific listing |
listing.read-write | Required by Rippling operations: Create a new listing; Delist listing; Publish listing |
location-factors.read | Read location factors data available to the authorized client |
metadata.read | Read metadata available to the authorized client |
metadata.read-write | Read and write metadata available to the authorized client |
off-cycle-payroll-runs.write | Create Global Payroll off-cycle runs |
onboarding-documents.write | Register company onboarding documents |
onboarding-plans.read | Read plans |
onboarding-steps.read | Read steps and step schemas |
onboarding-steps.read-write | Read steps, create/read submissions |
packages-install.read | Read package install data available to the authorized client |
packages-install.read-write | Read and write package install data available to the authorized client |
packages.read | Read packages data available to the authorized client |
packages.read-write | Read and write packages data available to the authorized client |
payroll-payment-mode-changes.read-write | Update worker payment modes in draft Global Payroll runs |
payroll-runs.read | Read payroll-runs data available to the authorized client |
payroll-runs/off-cycle.read-write | Required by Rippling operations: Create a new off-cycle payroll run |
platform-capabilities.read | Required by Rippling operations: List platform capabilities |
product-selections.read | Read product selections via Onboarding |
product-selections.write | Add and remove product selections via Onboarding |
report-runs.read | Required by Rippling operations: Retrieve a report run |
report-runs.read-write | Read reports data available to the authorized client |
reports.read | Read reports data available to the authorized client |
sandboxes.read | Read sandboxes data available to the authorized client |
sandboxes.read-write | Read and write sandboxes data available to the authorized client |
scheduled-job-assignments.read | Read scheduled job assignments data available to the authorized client |
scheduled-job-assignments.read-write | Read and write scheduled job assignments data available to the authorized client |
schedules.read | Read schedules data available to the authorized client |
schedules.read-write | Read and write schedules data available to the authorized client |
shift-inputs.read | Read shift inputs data available to the authorized client |
shift-inputs.read-write | Read and write shift inputs data available to the authorized client |
shiftassignments.read | Read shift assignments data available to the authorized client |
shiftassignments.read-write | Read and write shift assignments data available to the authorized client |
shiftassignments/{id}/customfields.write | Write shift assignments data available to the authorized client |
sites.read | Read Sites data available to the authorized client |
sites.read-write | Read and write Sites data available to the authorized client |
software-deployments.read | Read software deployment details |
software-deployments.read-write | Read and write software deployments data available to the authorized client |
sso-me.read | Read sso-me data available to the authorized client |
supergroups.read | Read supergroups data available to the authorized client |
supergroups.read-write | Read and write supergroups data available to the authorized client |
teams.read | Read teams data available to the authorized client |
teams.read-write | Read and write teams data available to the authorized client |
time-cards.read | Read time cards data available to the authorized client |
time-entries.read | Read time entries data available to the authorized client |
time-entries.read-write | Read and write time entries data available to the authorized client |
titles.read | Read titles data available to the authorized client |
titles.read-write | Read and write titles data available to the authorized client |
tracks.read | Read tracks data available to the authorized client |
tracks.read-write | Read and write tracks data available to the authorized client |
unassignedshifts.read | Read unassigned shifts data available to the authorized client |
unassignedshifts.read-write | Read and write unassigned shifts data available to the authorized client |
unassignedshifts/{id}/assign.write | Write unassigned shifts data available to the authorized client |
unassignedshifts/{id}/customfields.write | Write unassigned shifts data available to the authorized client |
users.read | Read users data available to the authorized client |
variable-compensation-payout-labels.read | Read variable compensation payout labels data available to the authorized client |
variable-compensation-payout-labels.read-write | Read and write variable compensation payout labels data available to the authorized client |
variable-compensation-payout-types.read | Read variable compensation payout types data available to the authorized client |
variable-compensation-payout-types.read-write | Read and write variable compensation payout types data available to the authorized client |
variable-compensation-payout-writes.read-write | Create and submit variable compensation payouts |
variable-compensation-payouts.read | Read variable compensation payouts data available to the authorized client |
variable-compensation-payouts.read-write | Read and write variable compensation payouts data available to the authorized client |
work-locations.read | Read work locations data available to the authorized client |
work-locations.read-write | Read and write work locations data available to the authorized client |
worker-change-fields.read | Read worker change fields data available to the authorized client |
worker-changes.read | Read worker changes data available to the authorized client |
worker-payroll-records.read | Read worker payroll records data available to the authorized client |
worker-time-splits.read | Read worker time splits data available to the authorized client |
worker-time-splits.read-write | Read and write worker time splits data available to the authorized client |
workers.compensation-grade.read | Read compensation grades for workers |
workers.custom-fields.read | Read custom field values for workers (Employee custom fields from Data Manager) |
workers.original-start-date.read | Read original start dates for workers |
workers.pay-schedule.read | Read pay schedule IDs for workers |
workers.read | Read workers data available to the authorized client |
workers.sensitive.personal.read | Read personal sensitive country fields from Workers API |
workers.work-schedule.read | Read work schedules for workers |
workflow-action-executions.read-write | Execute workflow actions via Workflows |
workflows.read | Read workflows available to the authorized client |
workflows.read-write | Read and write workflows available to the authorized client |
Legacy V1 Platform API
Section titled “Legacy V1 Platform API”| Scope | Description |
|---|---|
company | The parent company scope. This is a prerequisite to any additional company:* scopes, but does not serve as a scope superset. |
employee | The parent employee scope. This is a prerequisite to any additional employee:* scopes, but does not serve as a scope superset. |
company:read | Permission to read the company’s information. |
company:write | Permission to write the company’s information. |
company:activity:read | Permission to read information regarding the company’s activity. |
company:doingBusinessAsName:read | Permission to read the name the company is using to do business. |
company:legalName:read | Permission to read the company’s legal name. |
company:address:read | Permission to read the company’s address. |
company:phone:read | Permission to read the company’s phone information. |
company:departments:read | Permission to read the company’s departments. |
company:levels:read | Permission to read the company’s levels. |
company:titles:read | Permission to read the list of the company’s titles. |
company:employmentTypes:read | Permission to read the list of the company’s employment types. |
company:customFields:read | Permission to read the company’s custom fields. |
company:primaryWorkLocation:read | Permission to read the company’s primary work location. |
company:workLocations:read | Permission to read the company’s work locations. |
company:leave_requests:read | Permission to read the company’s leave request information. |
company:leave_requests:write | Permission to write the company’s leave request information. |
company:company_leave_types | Permission to read the company’s leave types. |
employee:read | Permission to read the employee’s information. |
employee:write | Permission to write the employee’s information. |
employee:name:read | Permission to read the company’s employees’ names. |
employee:preferredFirstName:read | Permission to read the company’s employees’ preferred first names. |
employee:preferredLastName:read | Permission to read the company’s employees’ preferred last names. |
employee:employmentType:read | Permission to read the company’s employees’ employment types. |
employee:workEmail:read | Permission to read the company’s employees’ work emails. |
employee:title:read | Permission to read the company’s employees’ titles. |
employee:endDate:read | Permission to read the company’s employees’ end dates. |
employee:employeeNumber:read | Permission to read the company’s employees’ employee number. |
employee:department:read | Permission to read the company’s employees’ department. |
employee:level:read | Permission to read the company’s employees’ levels information. |
employee:userId:read | Permission to read the company’s employees’ user IDs. |
employee:isManager:read | Permission to read whether the employee is a manager. |
employee:isRemote:read | Permission to read whether the employee is remote. |
employee:roleState:read | Permission to read the company’s employees’ role states. |
employee:manager:read | Permission to read the company’s employees’ managers. |
employee:teams:read | Permission to read the company’s employees’ teams. |
employee:workLocation:read | Permission to read the company’s employees’ work locations. |
employee:workLocationId:read | Permission to read the company’s employees’ work location. |
employee:customFields:read | Permission to read the company’s employees’ custom field information. |
employee:gender:read | Permission to read the company’s employees’ gender information. |
employee:identifiedGender:read | Permission to read the company’s employees’ identified gender information. |
employee:photo:read | Permission to read the company’s employees’ photo. |
employee:smallPhoto:read | Permission to read the company’s employees’ small photo. |
employee:uniqueId:read | Permission to read the employee’s permanent profile number. |
groups:read | Permission to read the company’s group information. |
groups:write | Permission to write to the company’s group information. |
group_members:read | Permission to read the company’s group membership information. |
group_members:write | Permission to write to the company’s group membership information. |
saml:idp_metadata | Permission to read the current company’s SAML metadata information. |
employee:saml | Permission to read the current employee’s SAML metadata information. |
company:teams:read | Permission to read the company’s list of teams. |
openid | Access to open ID (OIDC) SSO. |
insurance:read | Permission to read the organization’s insurance information. |
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.post-ats_candidates-push_candidate | payment, send, write | POST | /platform/api/ats_candidates/push_candidate |
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}/ |