Skip to content

Reference

Rippling

Set up Rippling OAuth through a Rippling App Shop listing for HR, IT, and payroll data

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).

PropertyValue
Provider IDrippling
CategoryHR
PKCESupported (S256 — Alter sends it; Rippling’s OAuth discovery advertises S256)
Token refreshAutomatic
Redirect URIShown in Developer Portal
API hostsrest.ripplingapis.com (V2 REST API), api.rippling.com (legacy V1 Platform API)

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.

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.

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.

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.

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:

FamilyRippling operations it covers
readEvery GET, plus the read-only POST queries (custom-object record queries, metadata extract and validate)
writeEvery create and update
deleteEvery DELETE, plus bulk deletion of custom-object records
paymentWrites that move money or change what people are paid: off-cycle payroll runs, payroll payment-mode changes, variable-compensation payouts, earnings inputs, job-assignment and job-code pay rates (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
sendWrites 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
adminOrg structure (departments, teams, levels, titles, tracks, job codes and dimensions, work locations, business partners), groups and supergroup membership, custom objects and apps, packages, sandboxes, sites, workflows, functions, agents, software deployments, and kiosk badges

Typical rules:

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

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.

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.deleted event. Revoke the connection with alter_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 with Retry-After beyond 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.

The scopes a listing can carry, from Rippling’s permissions reference and V1 scopes guide.

ScopeDescription
activity-log.readRead visible Activity Log events available to the authorized client
activity-log.sensitive-data.readRead sensitive Activity Log event data
agent-deployments.readRead agent deployments data available to the authorized client
agent-deployments.read-writeRead and write agent deployments data available to the authorized client
agent-sessions.readRead agent sessions data available to the authorized client
agent-sessions.read-writeRead and write agent sessions data available to the authorized client
agent-source-revisions.readRead agent source revisions data available to the authorized client
agent-source-revisions.read-writeRead and write agent source revisions data available to the authorized client
agents.readRead agents data available to the authorized client
agents.read-writeRead and write agents data available to the authorized client
app-users.readRead app users data available to the authorized client
background-check-candidates.readRead background check candidates data available to the authorized client
background-check-candidates.read-writeRead and write background check candidates data available to the authorized client
break-policies.readRead break policies data available to the authorized client
break-types.readRead break types data available to the authorized client
business-partner-groups.readRead business partner groups data available to the authorized client
business-partner-groups.read-writeRead and write business partner groups data available to the authorized client
business-partners.readRead business partners data available to the authorized client
business-partners.read-writeRead and write business partners data available to the authorized client
business-structure-paths.readRead business-structure-paths data available to the authorized client
business-structure-paths.read-writeRead and write business-structure-paths data available to the authorized client
candidate-applications.readRead candidate applications data available to the authorized client
candidate-applications.read-writeRead and write candidate applications data available to the authorized client
candidates.readRead candidates data available to the authorized client
companies.readRead companies data available to the authorized client
company-legal-entities.readRead company legal entities data available to the authorized client
company-legal-entity-workers.readRead company-legal-entity-workers data available to the authorized client
compensation-bands-details.readRead compensation bands details data available to the authorized client
compensations.readRead compensations data available to the authorized client
custom-apps.readRequired by Rippling operations: List CustomApp; Retrieve a specific CustomApp
custom-apps.read-writeRequired by Rippling operations: Create a new CustomApp; Delete a CustomApp; Update a CustomApp
custom-fields.readRead custom fields data available to the authorized client
custom-object-records.readRead custom object records data available to the authorized client
custom-object-records.read-writeRead and write custom object records data available to the authorized client
custom-object.read-write.ownerRequired by Rippling operations: Bulk Create custom object records
custom-objects.readRead custom-objects data available to the authorized client
custom-objects.read-writeRead and write custom-objects data available to the authorized client
custom-objects.read-write.ownerCreate new custom-objects, read and write custom-objects data owned by the authorized client
custom-pages.readRequired by Rippling operations: List CustomPage; Retrieve a specific CustomPage
custom-pages.read-writeRequired by Rippling operations: Create a new CustomPage; Delete a CustomPage; Update a CustomPage
custom-settings.readRead Custom-settings data available to the authorized client
custom-settings.read-writeRead and write Custom-settings data available to the authorized client
departments.readRead departments data available to the authorized client
departments.read-writeRead and write departments data available to the authorized client
developer-account.readRead developer account
developer-program-application.readRead Developer Program application for an existing company
developer-program-application.read-writeCreate a Developer Program application for an existing company
developer-users.readList developer users
device-orders.readRead device orders data available to the authorized client
devices.readRead devices data available to the authorized client
draft-hires.readRead draft hires data available to the authorized client
draft-hires.read-writeRead and write draft hires data available to the authorized client
draft-transitions.readRead draft transitions data available to the authorized client
draft-transitions.read-writeRead and write draft transitions data available to the authorized client
earning-types.readRead earning-types data available to the authorized client
earnings-inputs.readRead earnings-inputs data available to the authorized client
earnings-inputs.read-writeRead and write earnings-inputs data available to the authorized client
employee-documents.readRead employee documents data available to the authorized client
employee-documents.read-writeRead and write employee documents data available to the authorized client
employment-types.readRead employment types data available to the authorized client
entitlements.readRead entitlements data available to the authorized client
files.readRead files data available to the authorized client
files.read-writeRead and write files data available to the authorized client
files:upload-url.readRead file upload data available to the authorized client
files:upload-url.writeGenerate a presigned upload URL via File Upload
function-executions.readRead function executions data available to the authorized client
function-executions.read-writeRead and write function executions data available to the authorized client
function-executions.writeWrite function executions data available to the authorized client
functions.readRead functions data available to the authorized client
functions.read-writeRead and write functions data available to the authorized client
headcount-positions.compensation.readRead compensation data in headcount positions
headcount-positions.readRead headcount positions data available to the authorized client
headcount-priorities.readRead headcount priorities data available to the authorized client
hire-requirements.readRead hire requirements data available to the authorized client
hires.readRead hires data available to the authorized client
hires.read-writeRead and write hires data available to the authorized client
job-assignments.readRead job assignments data available to the authorized client
job-assignments.read-writeRead and write job assignments data available to the authorized client
job-codes.readRead job codes data available to the authorized client
job-codes.read-writeRead and write job codes data available to the authorized client
job-dimensions.readRead job dimensions data available to the authorized client
job-dimensions.read-writeRead and write job dimensions data available to the authorized client
job-functions.readRead job functions data available to the authorized client
job-pay-rate-exceptions.readRead job pay rate exceptions data available to the authorized client
job-requisitions-write.readRead job requisitions data available to the authorized client
job-requisitions-write.read-writeRead and write job requisitions data available to the authorized client
job-requisitions.readRead job requisitions data available to the authorized client
kiosk-badges.readRead kiosk badges data available to the authorized client
kiosk-badges.read-writeRead and write kiosk badges data available to the authorized client
leave-accruals.readRead leave accruals data available to the authorized client
leave-accruals.read-writeRead and write leave accruals data available to the authorized client
leave-balances.readRead leave balances data available to the authorized client
leave-program-evaluations.readRead leave program evaluations data available to the authorized client
leave-program-evaluations.read-writeRead and write leave program evaluations data available to the authorized client
leave-requests.readRead leave requests data available to the authorized client
leave-requests.read-writeRead and write leave requests data available to the authorized client
leave-types.readRead leave types data available to the authorized client
legal-entities.readRead legal entities data available to the authorized client
levels.readRead levels data available to the authorized client
levels.read-writeRead and write levels data available to the authorized client
listing-submissions.readRequired by Rippling operations: List listing submission; Retrieve a specific listing submission
listing-transitions.readRequired by Rippling operations: List listing transition
listing.readRequired by Rippling operations: List listing; Retrieve a specific listing
listing.read-writeRequired by Rippling operations: Create a new listing; Delist listing; Publish listing
location-factors.readRead location factors data available to the authorized client
metadata.readRead metadata available to the authorized client
metadata.read-writeRead and write metadata available to the authorized client
off-cycle-payroll-runs.writeCreate Global Payroll off-cycle runs
onboarding-documents.writeRegister company onboarding documents
onboarding-plans.readRead plans
onboarding-steps.readRead steps and step schemas
onboarding-steps.read-writeRead steps, create/read submissions
packages-install.readRead package install data available to the authorized client
packages-install.read-writeRead and write package install data available to the authorized client
packages.readRead packages data available to the authorized client
packages.read-writeRead and write packages data available to the authorized client
payroll-payment-mode-changes.read-writeUpdate worker payment modes in draft Global Payroll runs
payroll-runs.readRead payroll-runs data available to the authorized client
payroll-runs/off-cycle.read-writeRequired by Rippling operations: Create a new off-cycle payroll run
platform-capabilities.readRequired by Rippling operations: List platform capabilities
product-selections.readRead product selections via Onboarding
product-selections.writeAdd and remove product selections via Onboarding
report-runs.readRequired by Rippling operations: Retrieve a report run
report-runs.read-writeRead reports data available to the authorized client
reports.readRead reports data available to the authorized client
sandboxes.readRead sandboxes data available to the authorized client
sandboxes.read-writeRead and write sandboxes data available to the authorized client
scheduled-job-assignments.readRead scheduled job assignments data available to the authorized client
scheduled-job-assignments.read-writeRead and write scheduled job assignments data available to the authorized client
schedules.readRead schedules data available to the authorized client
schedules.read-writeRead and write schedules data available to the authorized client
shift-inputs.readRead shift inputs data available to the authorized client
shift-inputs.read-writeRead and write shift inputs data available to the authorized client
shiftassignments.readRead shift assignments data available to the authorized client
shiftassignments.read-writeRead and write shift assignments data available to the authorized client
shiftassignments/{id}/customfields.writeWrite shift assignments data available to the authorized client
sites.readRead Sites data available to the authorized client
sites.read-writeRead and write Sites data available to the authorized client
software-deployments.readRead software deployment details
software-deployments.read-writeRead and write software deployments data available to the authorized client
sso-me.readRead sso-me data available to the authorized client
supergroups.readRead supergroups data available to the authorized client
supergroups.read-writeRead and write supergroups data available to the authorized client
teams.readRead teams data available to the authorized client
teams.read-writeRead and write teams data available to the authorized client
time-cards.readRead time cards data available to the authorized client
time-entries.readRead time entries data available to the authorized client
time-entries.read-writeRead and write time entries data available to the authorized client
titles.readRead titles data available to the authorized client
titles.read-writeRead and write titles data available to the authorized client
tracks.readRead tracks data available to the authorized client
tracks.read-writeRead and write tracks data available to the authorized client
unassignedshifts.readRead unassigned shifts data available to the authorized client
unassignedshifts.read-writeRead and write unassigned shifts data available to the authorized client
unassignedshifts/{id}/assign.writeWrite unassigned shifts data available to the authorized client
unassignedshifts/{id}/customfields.writeWrite unassigned shifts data available to the authorized client
users.readRead users data available to the authorized client
variable-compensation-payout-labels.readRead variable compensation payout labels data available to the authorized client
variable-compensation-payout-labels.read-writeRead and write variable compensation payout labels data available to the authorized client
variable-compensation-payout-types.readRead variable compensation payout types data available to the authorized client
variable-compensation-payout-types.read-writeRead and write variable compensation payout types data available to the authorized client
variable-compensation-payout-writes.read-writeCreate and submit variable compensation payouts
variable-compensation-payouts.readRead variable compensation payouts data available to the authorized client
variable-compensation-payouts.read-writeRead and write variable compensation payouts data available to the authorized client
work-locations.readRead work locations data available to the authorized client
work-locations.read-writeRead and write work locations data available to the authorized client
worker-change-fields.readRead worker change fields data available to the authorized client
worker-changes.readRead worker changes data available to the authorized client
worker-payroll-records.readRead worker payroll records data available to the authorized client
worker-time-splits.readRead worker time splits data available to the authorized client
worker-time-splits.read-writeRead and write worker time splits data available to the authorized client
workers.compensation-grade.readRead compensation grades for workers
workers.custom-fields.readRead custom field values for workers (Employee custom fields from Data Manager)
workers.original-start-date.readRead original start dates for workers
workers.pay-schedule.readRead pay schedule IDs for workers
workers.readRead workers data available to the authorized client
workers.sensitive.personal.readRead personal sensitive country fields from Workers API
workers.work-schedule.readRead work schedules for workers
workflow-action-executions.read-writeExecute workflow actions via Workflows
workflows.readRead workflows available to the authorized client
workflows.read-writeRead and write workflows available to the authorized client
ScopeDescription
companyThe parent company scope. This is a prerequisite to any additional company:* scopes, but does not serve as a scope superset.
employeeThe parent employee scope. This is a prerequisite to any additional employee:* scopes, but does not serve as a scope superset.
company:readPermission to read the company’s information.
company:writePermission to write the company’s information.
company:activity:readPermission to read information regarding the company’s activity.
company:doingBusinessAsName:readPermission to read the name the company is using to do business.
company:legalName:readPermission to read the company’s legal name.
company:address:readPermission to read the company’s address.
company:phone:readPermission to read the company’s phone information.
company:departments:readPermission to read the company’s departments.
company:levels:readPermission to read the company’s levels.
company:titles:readPermission to read the list of the company’s titles.
company:employmentTypes:readPermission to read the list of the company’s employment types.
company:customFields:readPermission to read the company’s custom fields.
company:primaryWorkLocation:readPermission to read the company’s primary work location.
company:workLocations:readPermission to read the company’s work locations.
company:leave_requests:readPermission to read the company’s leave request information.
company:leave_requests:writePermission to write the company’s leave request information.
company:company_leave_typesPermission to read the company’s leave types.
employee:readPermission to read the employee’s information.
employee:writePermission to write the employee’s information.
employee:name:readPermission to read the company’s employees’ names.
employee:preferredFirstName:readPermission to read the company’s employees’ preferred first names.
employee:preferredLastName:readPermission to read the company’s employees’ preferred last names.
employee:employmentType:readPermission to read the company’s employees’ employment types.
employee:workEmail:readPermission to read the company’s employees’ work emails.
employee:title:readPermission to read the company’s employees’ titles.
employee:endDate:readPermission to read the company’s employees’ end dates.
employee:employeeNumber:readPermission to read the company’s employees’ employee number.
employee:department:readPermission to read the company’s employees’ department.
employee:level:readPermission to read the company’s employees’ levels information.
employee:userId:readPermission to read the company’s employees’ user IDs.
employee:isManager:readPermission to read whether the employee is a manager.
employee:isRemote:readPermission to read whether the employee is remote.
employee:roleState:readPermission to read the company’s employees’ role states.
employee:manager:readPermission to read the company’s employees’ managers.
employee:teams:readPermission to read the company’s employees’ teams.
employee:workLocation:readPermission to read the company’s employees’ work locations.
employee:workLocationId:readPermission to read the company’s employees’ work location.
employee:customFields:readPermission to read the company’s employees’ custom field information.
employee:gender:readPermission to read the company’s employees’ gender information.
employee:identifiedGender:readPermission to read the company’s employees’ identified gender information.
employee:photo:readPermission to read the company’s employees’ photo.
employee:smallPhoto:readPermission to read the company’s employees’ small photo.
employee:uniqueId:readPermission to read the employee’s permanent profile number.
groups:readPermission to read the company’s group information.
groups:writePermission to write to the company’s group information.
group_members:readPermission to read the company’s group membership information.
group_members:writePermission to write to the company’s group membership information.
saml:idp_metadataPermission to read the current company’s SAML metadata information.
employee:samlPermission to read the current employee’s SAML metadata information.
company:teams:readPermission to read the company’s list of teams.
openidAccess to open ID (OIDC) SSO.
insurance:readPermission to read the organization’s insurance information.

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

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

Report an issue with this page

Necessary

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

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

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

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