REST API for Nexus HCM

Every HTTP endpoint the application exposes, grouped by resource.

Calling the API

The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.

Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with 403 bad request. That refusal reads like a permissions fault but is not one. Integration and APIs lists the header per family.

Endpoints

815 endpoints in 146 resource groups.

absrules · activity · agentact · agentgov · agents · ai · alerts · api · appr-flows · automation · availability · bene · benefits · beneus · bpf · bu · cal · candidates · careers · cases · chatops · clock · comms · comp-awards · comp-cycles · comp-plan-enroll · comp-plans · comp-profiles · compliance · comply · connect · contracts · countries · coverage · custom-domain · dashboard · datahub · devices · doc-cases · efd · emp-comp · emp-skills · employee-documents · employees · empno-backfill · empno-config · enrollments · entities · entstruct · eor · equity · ess · ess-admin · exec-summary · feedback · fx · gender-coverage · gender-options · grade-bands · hcm · hcm-security · hr-appr-clock · hr-appr-levels · hr-delegations · hr-pending · journeys · journeys-assignments · labor-analytics · labor-forecast · lang · learnai · learning · leave · loa · login · logout · mail-transport · marketplace · me · merit · migrate · nxtz · onboard · orgchart · orgmodel · password · pay-advances · pay-elements · pay-equity · pay-providers · payops · payroll · payslips · perf-cycles · performance · perms · pips · plan2 · platform · policies · positions · predict · push · reach · recognition · recruit · reports · requisitions · retro · roles · rosters · safety · schedule-check · scheduling-rules · search · security · sender-domains · sender-emails · sender-options · sender-prefs · session · settings · setup-status · shift-bids · shift-swaps · shift-templates · shifts · sign · skillgraph · sod · spend · sso · statfile · statout · succession · system-email · talent · taxengine · timerules · timesheets · total-rewards · username · users · vms · voice · wellness

absrules 14

Method	Path	Access
GET	`/api/absrules`	signed in
POST	`/api/absrules`	administrator
DELETE	`/api/absrules/:id`	administrator
POST	`/api/absrules/adjust`	administrator
GET	`/api/absrules/balance`	signed in
GET	`/api/absrules/balances`	signed in
GET	`/api/absrules/banks`	administrator
POST	`/api/absrules/banks`	administrator
POST	`/api/absrules/banks/:id/donate`	administrator
POST	`/api/absrules/banks/:id/grant`	administrator
GET	`/api/absrules/calendar-check`	signed in
POST	`/api/absrules/cashout`	administrator
GET	`/api/absrules/ledger`	signed in
POST	`/api/absrules/rollover`	administrator

activity 1

Method	Path	Access
GET	`/api/activity`	administrator

agentact 12

Method	Path	Access
POST	`/api/agentact/:id/discard`	signed in
POST	`/api/agentact/:id/stage`	signed in
POST	`/api/agentact/act`	signed in
GET	`/api/agentact/actions`	administrator
GET	`/api/agentact/guard`	signed in
GET	`/api/agentact/objects`	administrator
POST	`/api/agentact/process`	administrator
GET	`/api/agentact/recipes`	signed in
POST	`/api/agentact/recipes`	administrator
PUT	`/api/agentact/recipes/:key/scope`	administrator
POST	`/api/agentact/recipes/:key/test`	administrator
GET	`/api/agentact/templates`	administrator

agentgov 2

Method	Path	Access
GET	`/api/agentgov`	signed in
PUT	`/api/agentgov/:agent`	administrator

agents 4

Method	Path	Access
GET	`/api/agents`	signed in
POST	`/api/agents/:key/ask`	signed in
POST	`/api/agents/concierge`	signed in
GET	`/api/agents/runs`	administrator

ai 2

Method	Path	Access
POST	`/api/ai/hcm`	signed in
GET	`/api/ai/status`	signed in

alerts 2

Method	Path	Access
GET	`/api/alerts`	signed in
POST	`/api/alerts/:id/resolve`	signed in

api 4

Method	Path	Access
DELETE	`/api/`	administrator
GET	`/api/`	signed in
POST	`/api/`	administrator
PUT	`/api/`	administrator

appr-flows 2

Method	Path	Access
GET	`/api/appr-flows`	administrator
PUT	`/api/appr-flows/:kind`	administrator

automation 3

Method	Path	Access
POST	`/api/automation/run`	administrator
GET	`/api/automation/status`	signed in
PUT	`/api/automation/toggles`	administrator

availability 4

Method	Path	Access
GET	`/api/availability`	signed in
POST	`/api/availability`	signed in
DELETE	`/api/availability/:id`	signed in
PUT	`/api/availability/:id`	signed in

bene 3

Method	Path	Access
GET	`/api/bene/billing`	signed in
GET	`/api/bene/guide`	signed in
POST	`/api/bene/windows/:id/rollover`	administrator

benefits 8

Method	Path	Access
GET	`/api/benefits`	signed in
POST	`/api/benefits`	administrator
POST	`/api/benefits/:id/enroll`	signed in
GET	`/api/benefits/life-event-types`	signed in
GET	`/api/benefits/life-events`	signed in
POST	`/api/benefits/life-events/:id/decide`	signed in
GET	`/api/benefits/windows`	signed in
POST	`/api/benefits/windows`	signed in

beneus 20

Method	Path	Access
GET	`/api/beneus/aca/1095c`	signed in
GET	`/api/beneus/aca/periods`	signed in
POST	`/api/beneus/aca/periods`	administrator
POST	`/api/beneus/aca/periods/:id/measure`	administrator
GET	`/api/beneus/aca/periods/:id/results`	signed in
GET	`/api/beneus/carrier-export`	signed in
GET	`/api/beneus/cobra`	signed in
POST	`/api/beneus/cobra`	administrator
POST	`/api/beneus/cobra/:id/notice`	administrator
GET	`/api/beneus/cobra/:id/notice.pdf`	signed in
POST	`/api/beneus/cobra/:id/status`	administrator
POST	`/api/beneus/cobra/sweep`	administrator
GET	`/api/beneus/eoi`	signed in
POST	`/api/beneus/eoi`	administrator
POST	`/api/beneus/eoi/:id/decide`	administrator
GET	`/api/beneus/qmcso`	signed in
POST	`/api/beneus/qmcso`	administrator
POST	`/api/beneus/qmcso/:id/status`	administrator
POST	`/api/beneus/settings`	administrator
GET	`/api/beneus/summary`	signed in

bpf 13

Method	Path	Access
GET	`/api/bpf/defs`	signed in
POST	`/api/bpf/defs`	administrator
POST	`/api/bpf/defs/:id/activate`	administrator
POST	`/api/bpf/defs/:id/retire`	administrator
GET	`/api/bpf/items`	signed in
GET	`/api/bpf/items/:id`	signed in
POST	`/api/bpf/items/:id/act`	administrator
POST	`/api/bpf/items/:id/cancel`	administrator
POST	`/api/bpf/items/:id/correct`	administrator
POST	`/api/bpf/items/:id/rescind`	administrator
GET	`/api/bpf/objects`	signed in
GET	`/api/bpf/records/:object`	signed in
POST	`/api/bpf/start`	administrator

bu 9

Method	Path	Access
GET	`/api/bu`	signed in
POST	`/api/bu/assign-org`	administrator
POST	`/api/bu/entities`	administrator
GET	`/api/bu/for-entity`	signed in
POST	`/api/bu/functions`	administrator
GET	`/api/bu/resolve`	signed in
POST	`/api/bu/service-providers`	administrator
POST	`/api/bu/service-providers/:id/delete`	administrator
POST	`/api/bu/units`	administrator

cal 5

Method	Path	Access
GET	`/api/cal/sessions`	signed in
POST	`/api/cal/sessions`	administrator
GET	`/api/cal/sessions/:id`	signed in
POST	`/api/cal/sessions/:id/lock`	administrator
POST	`/api/cal/sessions/:id/move`	administrator

candidates 9

Method	Path	Access
GET	`/api/candidates`	signed in
POST	`/api/candidates`	signed in
PUT	`/api/candidates/:id`	signed in
GET	`/api/candidates/:id/cv`	administrator
POST	`/api/candidates/:id/invite`	administrator
POST	`/api/candidates/:id/schedule-invite`	administrator
GET	`/api/candidates/:id/scorecards`	signed in
POST	`/api/candidates/:id/scorecards`	administrator
POST	`/api/candidates/:id/stage`	administrator

careers 7

Method	Path	Access
GET	`/api/careers/admin`	signed in
POST	`/api/careers/config`	administrator
POST	`/api/careers/publish/:reqId`	administrator
POST	`/api/careers/referrals`	signed in
POST	`/api/careers/referrals/process`	administrator
POST	`/api/careers/slots`	administrator
POST	`/api/careers/slots/:id/cancel`	administrator

cases 3

Method	Path	Access
GET	`/api/cases`	signed in
POST	`/api/cases`	signed in
PUT	`/api/cases/:id`	administrator

chatops 5

Method	Path	Access
GET	`/api/chatops/digest`	signed in
GET	`/api/chatops/hooks`	signed in
POST	`/api/chatops/hooks`	administrator
DELETE	`/api/chatops/hooks/:id`	administrator
POST	`/api/chatops/pump`	administrator

clock 8

Method	Path	Access
GET	`/api/clock/config`	signed in
GET	`/api/clock/day`	signed in
POST	`/api/clock/fences`	administrator
DELETE	`/api/clock/fences/:id`	administrator
POST	`/api/clock/kiosks`	administrator
POST	`/api/clock/pins/:employeeId`	administrator
POST	`/api/clock/punch`	signed in
GET	`/api/clock/status`	signed in

comms 4

Method	Path	Access
GET	`/api/comms/campaigns`	signed in
POST	`/api/comms/campaigns`	signed in
GET	`/api/comms/campaigns/:id`	signed in
POST	`/api/comms/campaigns/:id/send`	signed in

comp-awards 4

Method	Path	Access
GET	`/api/comp-awards`	signed in
PUT	`/api/comp-awards/:id`	administrator
POST	`/api/comp-awards/:id/apply`	administrator
POST	`/api/comp-awards/generate/:cycle_id`	administrator

comp-cycles 3

Method	Path	Access
GET	`/api/comp-cycles`	signed in
POST	`/api/comp-cycles`	administrator
PUT	`/api/comp-cycles/:id`	administrator

comp-plan-enroll 1

Method	Path	Access
DELETE	`/api/comp-plan-enroll/:id`	signed in

comp-plans 3

Method	Path	Access
GET	`/api/comp-plans`	signed in
POST	`/api/comp-plans`	administrator
POST	`/api/comp-plans/:id/enroll`	signed in

comp-profiles 2

Method	Path	Access
GET	`/api/comp-profiles`	signed in
PUT	`/api/comp-profiles/:country`	administrator

compliance 4

Method	Path	Access
GET	`/api/compliance`	signed in
POST	`/api/compliance`	signed in
PUT	`/api/compliance/:id`	signed in
GET	`/api/compliance/rules`	signed in

comply 20

Method	Path	Access
GET	`/api/comply/accessibility`	signed in
POST	`/api/comply/accessibility`	administrator
POST	`/api/comply/alerts/run`	administrator
POST	`/api/comply/consent-purposes`	administrator
GET	`/api/comply/consents`	signed in
GET	`/api/comply/consents/summary`	signed in
GET	`/api/comply/eligibility`	signed in
POST	`/api/comply/eligibility`	administrator
GET	`/api/comply/eligibility/missing`	signed in
GET	`/api/comply/erasure`	administrator
POST	`/api/comply/erasure`	administrator
POST	`/api/comply/erasure/:id/decide`	administrator
GET	`/api/comply/mobility`	signed in
POST	`/api/comply/mobility`	administrator
GET	`/api/comply/mobility/expiring`	signed in
GET	`/api/comply/retention`	signed in
POST	`/api/comply/retention`	administrator
DELETE	`/api/comply/retention/:id`	administrator
POST	`/api/comply/retention/run`	administrator
GET	`/api/comply/summary`	signed in

connect 25

Method	Path	Access
GET	`/api/connect/connections`	signed in
POST	`/api/connect/connections`	signed in
DELETE	`/api/connect/connections/:id`	signed in
PUT	`/api/connect/connections/:id`	signed in
POST	`/api/connect/connections/:id/call`	signed in
POST	`/api/connect/connections/:id/test`	signed in
GET	`/api/connect/hooks`	signed in
POST	`/api/connect/hooks`	signed in
DELETE	`/api/connect/hooks/:id`	signed in
PUT	`/api/connect/hooks/:id`	signed in
GET	`/api/connect/hooks/:id/events`	signed in
GET	`/api/connect/log`	signed in
GET	`/api/connect/meta`	signed in
GET	`/api/connect/subs`	signed in
POST	`/api/connect/subs`	signed in
DELETE	`/api/connect/subs/:id`	signed in
PUT	`/api/connect/subs/:id`	signed in
POST	`/api/connect/subs/:id/test`	administrator
GET	`/api/connect/tokens`	signed in
POST	`/api/connect/tokens`	signed in
DELETE	`/api/connect/tokens/:id`	signed in
PUT	`/api/connect/tokens/:id`	signed in
POST	`/connect/hook/:slug`	signed in
GET	`/connect/mcp`	signed in
POST	`/connect/mcp`	signed in

contracts 6

Method	Path	Access
GET	`/api/contracts`	signed in
POST	`/api/contracts`	signed in
DELETE	`/api/contracts/:id`	administrator
GET	`/api/contracts/:id`	signed in
GET	`/api/contracts/:id/download`	signed in
POST	`/api/contracts/:id/status`	signed in

countries 1

Method	Path	Access
GET	`/api/countries`	signed in

coverage 4

Method	Path	Access
GET	`/api/coverage`	signed in
POST	`/api/coverage`	administrator
DELETE	`/api/coverage/:id`	administrator
PUT	`/api/coverage/:id`	administrator

custom-domain 3

Method	Path	Access
GET	`/api/custom-domain`	signed in
PUT	`/api/custom-domain`	signed in
POST	`/api/custom-domain/verify`	signed in

dashboard 1

Method	Path	Access
GET	`/api/dashboard`	signed in

datahub 5

Method	Path	Access
POST	`/api/datahub/boards`	administrator
GET	`/api/datahub/boards/:id/run`	signed in
GET	`/api/datahub/datasets`	signed in
POST	`/api/datahub/datasets`	administrator
DELETE	`/api/datahub/datasets/:id`	administrator

devices 3

Method	Path	Access
GET	`/api/devices`	signed in
POST	`/api/devices`	signed in
PUT	`/api/devices/:id`	signed in

doc-cases 1

Method	Path	Access
POST	`/api/doc-cases/:id/decide`	administrator

efd 10

Method	Path	Access
GET	`/api/efd/:object/:id`	signed in
POST	`/api/efd/:object/:id`	administrator
GET	`/api/efd/:object/:id/as-of`	signed in
POST	`/api/efd/change/:cid/correct`	administrator
POST	`/api/efd/change/:cid/rescind`	administrator
GET	`/api/efd/objects`	signed in
GET	`/api/efd/pending`	signed in
GET	`/api/efd/records/:object`	signed in
GET	`/api/efd/retro-candidates`	signed in
POST	`/api/efd/roll`	administrator

emp-comp 1

Method	Path	Access
DELETE	`/api/emp-comp/:id`	signed in

emp-skills 3

Method	Path	Access
GET	`/api/emp-skills`	signed in
POST	`/api/emp-skills`	signed in
DELETE	`/api/emp-skills/:id`	signed in

employee-documents 3

Method	Path	Access
DELETE	`/api/employee-documents/:id`	administrator
GET	`/api/employee-documents/:id/download`	signed in
POST	`/api/employee-documents/:id/vet`	administrator

employees 22

Method	Path	Access
GET	`/api/employees`	signed in
POST	`/api/employees`	signed in
GET	`/api/employees/:id`	signed in
PUT	`/api/employees/:id`	signed in
POST	`/api/employees/:id/assignment`	administrator
PUT	`/api/employees/:id/bank`	administrator
GET	`/api/employees/:id/comp`	signed in
POST	`/api/employees/:id/comp`	signed in
GET	`/api/employees/:id/doc-cases`	administrator
GET	`/api/employees/:id/documents`	signed in
POST	`/api/employees/:id/documents`	signed in
GET	`/api/employees/:id/ess-activity`	administrator
PUT	`/api/employees/:id/executive`	administrator
POST	`/api/employees/:id/invite`	administrator
POST	`/api/employees/:id/offboard`	signed in
DELETE	`/api/employees/:id/package`	administrator
GET	`/api/employees/:id/package`	signed in
PUT	`/api/employees/:id/package`	administrator
GET	`/api/employees/:id/photo`	signed in
POST	`/api/employees/:id/photo`	administrator
GET	`/api/employees/:id/rent`	signed in
PUT	`/api/employees/:id/rent`	signed in

empno-backfill 1

Method	Path	Access
POST	`/api/empno-backfill`	administrator

empno-config 2

Method	Path	Access
GET	`/api/empno-config`	administrator
PUT	`/api/empno-config`	administrator

enrollments 3

Method	Path	Access
GET	`/api/enrollments`	signed in
POST	`/api/enrollments`	administrator
PUT	`/api/enrollments/:id`	signed in

entities 6

Method	Path	Access
GET	`/api/entities`	signed in
POST	`/api/entities`	administrator
DELETE	`/api/entities/:id`	administrator
PUT	`/api/entities/:id`	administrator
PUT	`/api/entities/:id/hr`	administrator
GET	`/api/entities/hr`	administrator

entstruct 3

Method	Path	Access
GET	`/api/entstruct`	signed in
POST	`/api/entstruct/registrations`	administrator
POST	`/api/entstruct/registrations/:id/delete`	administrator

eor 1

Method	Path	Access
GET	`/api/eor`	signed in

equity 3

Method	Path	Access
GET	`/api/equity/grants`	signed in
POST	`/api/equity/grants`	administrator
POST	`/api/equity/grants/:id/cancel`	administrator

ess 82

Method	Path	Access
GET	`/api/ess/absence/balances`	signed in
POST	`/api/ess/absence/cashout`	signed in
POST	`/api/ess/absence/donate`	signed in
GET	`/api/ess/absence/working-days`	signed in
POST	`/api/ess/agent/:id/stage`	signed in
POST	`/api/ess/agent/act`	signed in
GET	`/api/ess/agent/actions`	signed in
GET	`/api/ess/agent/recipes`	signed in
POST	`/api/ess/availability`	signed in
GET	`/api/ess/bank`	signed in
PUT	`/api/ess/bank`	signed in
GET	`/api/ess/benefit-plans`	signed in
POST	`/api/ess/benefits/enroll`	signed in
GET	`/api/ess/benefits2`	signed in
POST	`/api/ess/benefits2/dependents`	signed in
DELETE	`/api/ess/benefits2/dependents/:id`	signed in
POST	`/api/ess/benefits2/life-event`	signed in
POST	`/api/ess/cases`	signed in
GET	`/api/ess/comp`	signed in
GET	`/api/ess/consents`	signed in
POST	`/api/ess/consents`	signed in
GET	`/api/ess/contract/:id`	signed in
GET	`/api/ess/contract/:id/download`	signed in
GET	`/api/ess/courses`	signed in
POST	`/api/ess/courses/:id/enroll`	signed in
GET	`/api/ess/directory`	signed in
GET	`/api/ess/doc-cases`	signed in
POST	`/api/ess/doc-submit`	signed in
GET	`/api/ess/documents`	signed in
POST	`/api/ess/documents`	signed in
GET	`/api/ess/documents/:id/download`	signed in
PUT	`/api/ess/enrollments/:id`	signed in
GET	`/api/ess/expenses`	signed in
POST	`/api/ess/expenses`	signed in
GET	`/api/ess/expenses/:id/receipt`	signed in
POST	`/api/ess/goals`	signed in
PUT	`/api/ess/goals/:id`	signed in
GET	`/api/ess/inbox`	signed in
GET	`/api/ess/jobs`	signed in
POST	`/api/ess/jobs/:id/apply`	signed in
GET	`/api/ess/learnai/quizzes`	signed in
POST	`/api/ess/learnai/quizzes/:id/attempt`	signed in
GET	`/api/ess/learnai/sessions`	signed in
POST	`/api/ess/learnai/sessions/:id/book`	signed in
POST	`/api/ess/learnai/sessions/:id/cancel`	signed in
POST	`/api/ess/learnai/tutor`	signed in
POST	`/api/ess/leave`	signed in
GET	`/api/ess/marketplace`	signed in
POST	`/api/ess/marketplace/apply`	signed in
GET	`/api/ess/me`	signed in
POST	`/api/ess/mentor/decide`	signed in
POST	`/api/ess/mentor/register`	signed in
POST	`/api/ess/mentor/request`	signed in
GET	`/api/ess/mobile`	administrator
GET	`/api/ess/pay-advance`	signed in
POST	`/api/ess/pay-advance`	signed in
GET	`/api/ess/pay-overview`	signed in
GET	`/api/ess/payslips/:id/pdf`	signed in
GET	`/api/ess/performance`	signed in
POST	`/api/ess/photo`	signed in
GET	`/api/ess/photo/:empId`	signed in
GET	`/api/ess/platform/values`	signed in
PUT	`/api/ess/platform/values`	signed in
GET	`/api/ess/profile`	signed in
PUT	`/api/ess/profile`	signed in
GET	`/api/ess/recognition`	signed in
POST	`/api/ess/recognition/redeem`	signed in
PUT	`/api/ess/reviews/:id/self`	signed in
GET	`/api/ess/shifts`	signed in
POST	`/api/ess/shifts/:id/claim`	signed in
GET	`/api/ess/skills`	signed in
POST	`/api/ess/skills`	signed in
DELETE	`/api/ess/skills/:id`	signed in
POST	`/api/ess/swaps`	signed in
GET	`/api/ess/timerules`	signed in
GET	`/api/ess/timesheets`	signed in
POST	`/api/ess/timesheets`	signed in
GET	`/api/ess/total-rewards`	signed in
GET	`/api/ess/voice`	signed in
POST	`/api/ess/voice/:id`	signed in
GET	`/api/ess/wellness`	signed in
POST	`/api/ess/wellness/use`	signed in

ess-admin 1

Method	Path	Access
POST	`/api/ess-admin/decide`	administrator

exec-summary 1

Method	Path	Access
GET	`/api/exec-summary`	administrator

feedback 3

Method	Path	Access
GET	`/api/feedback`	signed in
POST	`/api/feedback/:id/submit`	signed in
POST	`/api/feedback/request`	administrator

fx 2

Method	Path	Access
GET	`/api/fx`	administrator
POST	`/api/fx/refresh`	administrator

gender-coverage 1

Method	Path	Access
GET	`/api/gender-coverage`	signed in

gender-options 1

Method	Path	Access
GET	`/api/gender-options`	signed in

grade-bands 2

Method	Path	Access
GET	`/api/grade-bands`	signed in
PUT	`/api/grade-bands`	administrator

hcm 1

Method	Path	Access
GET	`/api/hcm/overview`	signed in

hcm-security 5

Method	Path	Access
GET	`/api/hcm-security`	signed in
POST	`/api/hcm-security`	administrator
POST	`/api/hcm-security/groups`	administrator
GET	`/api/hcm-security/my-access`	signed in
GET	`/api/hcm-security/preview`	administrator

hr-appr-clock 2

Method	Path	Access
GET	`/api/hr-appr-clock`	signed in
PUT	`/api/hr-appr-clock/:kind`	administrator

hr-appr-levels 2

Method	Path	Access
GET	`/api/hr-appr-levels`	signed in
PUT	`/api/hr-appr-levels/:kind`	administrator

hr-delegations 6

Method	Path	Access
GET	`/api/hr-delegations`	signed in
POST	`/api/hr-delegations`	signed in
DELETE	`/api/hr-delegations/:id`	signed in
PUT	`/api/hr-delegations/:id`	signed in
GET	`/api/hr-delegations/all`	administrator
GET	`/api/hr-delegations/candidates`	signed in

hr-pending 12

Method	Path	Access
GET	`/api/hr-pending`	signed in
POST	`/api/hr-pending/:id/answer-info`	signed in
GET	`/api/hr-pending/:id/candidates`	signed in
POST	`/api/hr-pending/:id/comment`	signed in
POST	`/api/hr-pending/:id/reassign`	signed in
POST	`/api/hr-pending/:id/request-info`	signed in
POST	`/api/hr-pending/:id/resume`	signed in
POST	`/api/hr-pending/:id/skip`	administrator
POST	`/api/hr-pending/:id/suspend`	signed in
GET	`/api/hr-pending/:id/trail`	signed in
GET	`/api/hr-pending/stats`	signed in
POST	`/api/hr-pending/sync`	administrator

journeys 4

Method	Path	Access
POST	`/api/journeys/:id/assign`	administrator
GET	`/api/journeys/:id/tasks`	administrator
POST	`/api/journeys/:id/tasks`	administrator
DELETE	`/api/journeys/tasks/:tid`	administrator

journeys-assignments 2

Method	Path	Access
GET	`/api/journeys-assignments`	signed in
PUT	`/api/journeys-assignments/:id`	signed in

labor-analytics 1

Method	Path	Access
GET	`/api/labor-analytics`	signed in

labor-forecast 2

Method	Path	Access
GET	`/api/labor-forecast`	signed in
POST	`/api/labor-forecast/generate`	administrator

lang 2

Method	Path	Access
GET	`/api/lang/enabled`	administrator
PUT	`/api/lang/enabled`	administrator

learnai 19

Method	Path	Access
GET	`/api/learnai/campaigns`	signed in
POST	`/api/learnai/campaigns`	administrator
POST	`/api/learnai/campaigns/:id/launch`	administrator
GET	`/api/learnai/campaigns/:id/metrics`	signed in
POST	`/api/learnai/generate`	administrator
GET	`/api/learnai/quizzes`	signed in
POST	`/api/learnai/quizzes`	administrator
DELETE	`/api/learnai/quizzes/:id`	administrator
PUT	`/api/learnai/quizzes/:id`	administrator
GET	`/api/learnai/quizzes/:id/attempts`	signed in
GET	`/api/learnai/sessions`	signed in
POST	`/api/learnai/sessions`	administrator
POST	`/api/learnai/sessions/:id/attendance`	administrator
POST	`/api/learnai/sessions/:id/book`	administrator
POST	`/api/learnai/sessions/:id/cancel`	administrator
GET	`/api/learnai/sessions/:id/seats`	signed in
GET	`/api/learnai/summary`	signed in
POST	`/api/learnai/tutor`	signed in
GET	`/api/learnai/tutor/log`	administrator

learning 14

Method	Path	Access
GET	`/api/learning/attempts`	signed in
POST	`/api/learning/attempts/:aid/commit`	signed in
POST	`/api/learning/attempts/:aid/xapi`	signed in
POST	`/api/learning/import-catalog`	administrator
GET	`/api/learning/packages`	signed in
POST	`/api/learning/packages`	administrator
DELETE	`/api/learning/packages/:id`	administrator
POST	`/api/learning/packages/:id/launch`	signed in
GET	`/api/learning/pkg/:id/*`	signed in
GET	`/api/learning/play/:aid`	signed in
GET	`/api/learning/recert`	signed in
POST	`/api/learning/recert`	administrator
POST	`/api/learning/recert/:id/toggle`	administrator
POST	`/api/learning/recert/run`	administrator

leave 3

Method	Path	Access
GET	`/api/leave`	signed in
POST	`/api/leave`	signed in
POST	`/api/leave/:id/decide`	signed in

loa 9

Method	Path	Access
GET	`/api/loa/cases`	signed in
POST	`/api/loa/cases`	administrator
POST	`/api/loa/cases/:id/close`	administrator
POST	`/api/loa/cases/:id/episodes`	administrator
POST	`/api/loa/cases/:id/rtw`	administrator
GET	`/api/loa/eligibility`	signed in
GET	`/api/loa/families`	administrator
PUT	`/api/loa/families/:id`	administrator
GET	`/api/loa/forecast`	signed in

Method	Path	Access
POST	`/api/login`	public
POST	`/api/login/2fa`	public

logout 1

Method	Path	Access
POST	`/api/logout`	signed in

mail-transport 3

Method	Path	Access
GET	`/api/mail-transport`	administrator
PUT	`/api/mail-transport`	administrator
POST	`/api/mail-transport/test`	administrator

marketplace 4

Method	Path	Access
GET	`/api/marketplace/gigs`	signed in
POST	`/api/marketplace/gigs`	signed in
GET	`/api/marketplace/gigs/:id`	signed in
POST	`/api/marketplace/gigs/:id/decide`	signed in

me 5

Method	Path	Access
GET	`/api/me/flags`	signed in
POST	`/api/me/flags`	signed in
POST	`/api/me/password`	signed in
GET	`/api/me/profile`	signed in
PUT	`/api/me/profile`	signed in

merit 7

Method	Path	Access
POST	`/api/merit/:cycle/apply-guidelines`	administrator
GET	`/api/merit/:cycle/matrix`	administrator
PUT	`/api/merit/:cycle/matrix`	administrator
GET	`/api/merit/:cycle/pools`	signed in
POST	`/api/merit/:cycle/pools`	administrator
GET	`/api/merit/:cycle/review`	signed in
DELETE	`/api/merit/pools/:id`	administrator

migrate 3

Method	Path	Access
POST	`/api/migrate/hcm/commit`	administrator
POST	`/api/migrate/hcm/preview`	administrator
GET	`/api/migrate/hcm/sources`	administrator

nxtz 3

Method	Path	Access
GET	`/api/nxtz`	signed in
PUT	`/api/nxtz`	signed in
POST	`/api/nxtz/device`	signed in

onboard 1

Method	Path	Access
POST	`/api/onboard/:task_id/done`	signed in

orgchart 1

Method	Path	Access
GET	`/api/orgchart`	signed in

orgmodel 6

Method	Path	Access
GET	`/api/orgmodel`	signed in
POST	`/api/orgmodel`	administrator
GET	`/api/orgmodel/:id`	signed in
POST	`/api/orgmodel/:id/approve`	administrator
POST	`/api/orgmodel/:id/execute`	administrator
POST	`/api/orgmodel/:id/move`	administrator

password 2

Method	Path	Access
POST	`/api/password/forgot`	public
POST	`/api/password/reset`	signed in

pay-advances 2

Method	Path	Access
GET	`/api/pay-advances`	signed in
POST	`/api/pay-advances/:id/decide`	signed in

pay-elements 4

Method	Path	Access
GET	`/api/pay-elements`	administrator
POST	`/api/pay-elements`	administrator
DELETE	`/api/pay-elements/:id`	administrator
POST	`/api/pay-elements/test`	administrator

pay-equity 1

Method	Path	Access
GET	`/api/pay-equity`	signed in

pay-providers 3

Method	Path	Access
GET	`/api/pay-providers`	administrator
POST	`/api/pay-providers`	administrator
DELETE	`/api/pay-providers/:id`	administrator

payops 17

Method	Path	Access
GET	`/api/payops/arrears`	signed in
POST	`/api/payops/arrears`	administrator
POST	`/api/payops/arrears/:id/close`	administrator
GET	`/api/payops/costing`	signed in
POST	`/api/payops/costing`	administrator
GET	`/api/payops/garnishments`	signed in
POST	`/api/payops/garnishments`	administrator
POST	`/api/payops/garnishments/:id/stop`	administrator
GET	`/api/payops/grossup`	signed in
GET	`/api/payops/groups`	signed in
POST	`/api/payops/groups`	administrator
POST	`/api/payops/groups/:id/assign`	administrator
POST	`/api/payops/offcycle`	signed in
GET	`/api/payops/runs/:id/gl`	signed in
POST	`/api/payops/runs/:id/reallocate`	administrator
GET	`/api/payops/slips/:id/adjustments`	signed in
GET	`/api/payops/summary`	signed in

payroll 8

Method	Path	Access
GET	`/api/payroll/runs`	signed in
POST	`/api/payroll/runs`	signed in
GET	`/api/payroll/runs/:id`	signed in
POST	`/api/payroll/runs/:id/approve`	administrator
POST	`/api/payroll/runs/:id/pay`	administrator
GET	`/api/payroll/runs/:id/payfile`	administrator
GET	`/api/payroll/runs/:id/submissions`	administrator
POST	`/api/payroll/runs/:id/submit`	administrator

payslips 3

Method	Path	Access
GET	`/api/payslips`	signed in
GET	`/api/payslips/:id/doc`	signed in
GET	`/api/payslips/:id/pdf`	signed in

perf-cycles 3

Method	Path	Access
GET	`/api/perf-cycles`	signed in
POST	`/api/perf-cycles`	administrator
PUT	`/api/perf-cycles/:id`	administrator

performance 3

Method	Path	Access
GET	`/api/performance`	signed in
PUT	`/api/performance/:id`	signed in
POST	`/api/performance/generate/:cycle_id`	administrator

perms 2

Method	Path	Access
GET	`/api/perms/catalog`	signed in
GET	`/api/perms/resolved`	administrator

pips 4

Method	Path	Access
GET	`/api/pips`	signed in
POST	`/api/pips`	administrator
POST	`/api/pips/:id/close`	administrator
POST	`/api/pips/:id/items/:item/done`	administrator

plan2 9

Method	Path	Access
GET	`/api/plan2/compare`	signed in
DELETE	`/api/plan2/lines/:id`	administrator
GET	`/api/plan2/scenarios`	signed in
POST	`/api/plan2/scenarios`	administrator
GET	`/api/plan2/scenarios/:id`	signed in
POST	`/api/plan2/scenarios/:id/approve`	administrator
POST	`/api/plan2/scenarios/:id/lines`	administrator
POST	`/api/plan2/scenarios/:id/publish`	administrator
GET	`/api/plan2/scenarios/:id/reconcile`	signed in

platform 19

Method	Path	Access
GET	`/api/platform/actions`	administrator
POST	`/api/platform/actions`	administrator
DELETE	`/api/platform/actions/:id`	administrator
POST	`/api/platform/actions/:id/run`	signed in
GET	`/api/platform/exchange`	administrator
POST	`/api/platform/exchange`	administrator
DELETE	`/api/platform/exchange/:id`	administrator
POST	`/api/platform/exchange/:id/run`	administrator
GET	`/api/platform/exchange/preview`	administrator
GET	`/api/platform/fields`	signed in
POST	`/api/platform/fields`	administrator
DELETE	`/api/platform/fields/:id`	administrator
GET	`/api/platform/mobile`	administrator
POST	`/api/platform/mobile`	administrator
GET	`/api/platform/scim`	administrator
POST	`/api/platform/scim/token`	administrator
GET	`/api/platform/summary`	administrator
GET	`/api/platform/values/:object/:id`	signed in
PUT	`/api/platform/values/:object/:id`	administrator

policies 1

Method	Path	Access
GET	`/api/policies/:id/acks`	signed in

positions 4

Method	Path	Access
GET	`/api/positions`	signed in
POST	`/api/positions`	administrator
DELETE	`/api/positions/:id`	administrator
PUT	`/api/positions/:id`	administrator

predict 1

Method	Path	Access
GET	`/api/predict/attrition`	signed in

push 4

Method	Path	Access
GET	`/api/push/key`	signed in
POST	`/api/push/subscribe`	signed in
POST	`/api/push/test`	signed in
POST	`/api/push/unsubscribe`	signed in

reach 18

Method	Path	Access
GET	`/api/reach/bgchecks`	signed in
POST	`/api/reach/bgchecks`	administrator
POST	`/api/reach/bgchecks/:id/result`	administrator
GET	`/api/reach/campaigns`	signed in
POST	`/api/reach/campaigns`	administrator
POST	`/api/reach/campaigns/:id/send`	administrator
GET	`/api/reach/config`	administrator
POST	`/api/reach/config`	administrator
GET	`/api/reach/match/:reqId`	signed in
POST	`/api/reach/match/:reqId`	administrator
GET	`/api/reach/messages`	signed in
POST	`/api/reach/messages`	administrator
GET	`/api/reach/pools`	signed in
POST	`/api/reach/pools`	administrator
GET	`/api/reach/pools/:id/members`	signed in
POST	`/api/reach/pools/:id/members`	administrator
DELETE	`/api/reach/pools/:id/members/:mid`	administrator
GET	`/api/reach/summary`	signed in

recognition 9

Method	Path	Access
POST	`/api/recognition/:id/react`	signed in
GET	`/api/recognition/anniversaries`	signed in
GET	`/api/recognition/feed`	signed in
POST	`/api/recognition/give`	signed in
GET	`/api/recognition/leaderboard`	signed in
GET	`/api/recognition/programs`	signed in
POST	`/api/recognition/programs`	signed in
GET	`/api/recognition/redemptions`	signed in
POST	`/api/recognition/redemptions/:id/decide`	signed in

recruit 4

Method	Path	Access
GET	`/api/recruit/applicants`	administrator
POST	`/api/recruit/fetch-now`	administrator
GET	`/api/recruit/receiver`	administrator
PUT	`/api/recruit/receiver`	administrator

reports 6

Method	Path	Access
GET	`/api/reports/exec-comp`	signed in
GET	`/api/reports/export/:what`	signed in
GET	`/api/reports/headcount`	signed in
GET	`/api/reports/leave`	signed in
GET	`/api/reports/payroll`	signed in
GET	`/api/reports/turnover`	signed in

requisitions 2

Method	Path	Access
GET	`/api/requisitions`	signed in
POST	`/api/requisitions`	signed in

retro 4

Method	Path	Access
POST	`/api/retro/candidate/:id/close`	administrator
POST	`/api/retro/delta/:id/dismiss`	administrator
GET	`/api/retro/overview`	signed in
POST	`/api/retro/process`	administrator

roles 5

Method	Path	Access
GET	`/api/roles`	administrator
POST	`/api/roles`	administrator
DELETE	`/api/roles/:id`	administrator
PUT	`/api/roles/:id`	administrator
GET	`/api/roles/:id/users`	administrator

rosters 8

Method	Path	Access
GET	`/api/rosters`	signed in
POST	`/api/rosters`	administrator
DELETE	`/api/rosters/:id`	administrator
GET	`/api/rosters/:id`	signed in
PUT	`/api/rosters/:id`	administrator
POST	`/api/rosters/:id/autofill`	administrator
POST	`/api/rosters/:id/copy`	administrator
POST	`/api/rosters/:id/publish`	administrator

safety 3

Method	Path	Access
GET	`/api/safety`	signed in
POST	`/api/safety`	signed in
PUT	`/api/safety/:id`	administrator

schedule-check 1

Method	Path	Access
POST	`/api/schedule-check`	signed in

scheduling-rules 4

Method	Path	Access
GET	`/api/scheduling-rules`	signed in
POST	`/api/scheduling-rules`	administrator
DELETE	`/api/scheduling-rules/:id`	administrator
PUT	`/api/scheduling-rules/:id`	administrator

search 2

Method	Path	Access
GET	`/api/search`	signed in
GET	`/api/search/coverage`	signed in

security 8

Method	Path	Access
GET	`/api/security/data-roles`	administrator
POST	`/api/security/data-roles`	administrator
DELETE	`/api/security/data-roles/:id`	administrator
GET	`/api/security/profiles`	administrator
POST	`/api/security/profiles`	administrator
DELETE	`/api/security/profiles/:id`	administrator
GET	`/api/security/user-roles`	administrator
POST	`/api/security/user-roles`	administrator

sender-domains 1

Method	Path	Access
GET	`/api/sender-domains/:domain/dkim`	signed in

sender-emails 6

Method	Path	Access
POST	`/api/sender-emails`	signed in
DELETE	`/api/sender-emails/:id`	signed in
PUT	`/api/sender-emails/:id`	signed in
POST	`/api/sender-emails/:id/primary`	signed in
POST	`/api/sender-emails/:id/resend`	signed in
POST	`/api/sender-emails/:id/verify`	signed in

sender-options 1

Method	Path	Access
GET	`/api/sender-options`	signed in

sender-prefs 1

Method	Path	Access
GET	`/api/sender-prefs`	signed in

session 1

Method	Path	Access
GET	`/api/session`	signed in

settings 2

Method	Path	Access
GET	`/api/settings`	administrator
PUT	`/api/settings`	administrator

setup-status 2

Method	Path	Access
GET	`/api/setup-status`	administrator
POST	`/api/setup-status/dismiss`	administrator

shift-bids 3

Method	Path	Access
GET	`/api/shift-bids`	signed in
POST	`/api/shift-bids`	signed in
POST	`/api/shift-bids/:id/award`	administrator

shift-swaps 3

Method	Path	Access
GET	`/api/shift-swaps`	signed in
POST	`/api/shift-swaps`	signed in
POST	`/api/shift-swaps/:id/decide`	administrator

shift-templates 4

Method	Path	Access
GET	`/api/shift-templates`	signed in
POST	`/api/shift-templates`	administrator
DELETE	`/api/shift-templates/:id`	administrator
PUT	`/api/shift-templates/:id`	administrator

shifts 8

Method	Path	Access
GET	`/api/shifts`	signed in
POST	`/api/shifts`	administrator
DELETE	`/api/shifts/:id`	administrator
PUT	`/api/shifts/:id`	administrator
POST	`/api/shifts/:id/assign`	administrator
POST	`/api/shifts/:id/clock`	signed in
POST	`/api/shifts/bulk`	administrator
GET	`/api/shifts/open`	signed in

sign 6

Method	Path	Access
GET	`/api/sign/requests`	signed in
POST	`/api/sign/requests`	administrator
POST	`/api/sign/requests/:id/cancel`	administrator
POST	`/api/sign/requests/:id/resend`	administrator
GET	`/api/sign/requests/:id/sealed`	signed in
GET	`/api/sign/sources`	signed in

skillgraph 9

Method	Path	Access
POST	`/api/skillgraph/aliases`	administrator
POST	`/api/skillgraph/endorse/:employeeSkillId`	signed in
GET	`/api/skillgraph/gap`	signed in
POST	`/api/skillgraph/infer`	administrator
POST	`/api/skillgraph/job-skills`	administrator
GET	`/api/skillgraph/ontology`	signed in
GET	`/api/skillgraph/profile/:employeeId`	signed in
GET	`/api/skillgraph/recommend/gig/:gigId`	signed in
POST	`/api/skillgraph/relations`	administrator

sod 4

Method	Path	Access
POST	`/api/sod/ack`	administrator
GET	`/api/sod/analysis`	signed in
GET	`/api/sod/rules`	administrator
POST	`/api/sod/rules`	administrator

spend 7

Method	Path	Access
GET	`/api/spend/cards`	signed in
POST	`/api/spend/cards/:id/assign`	administrator
POST	`/api/spend/extract`	signed in
POST	`/api/spend/import-cards`	administrator
POST	`/api/spend/mileage`	administrator
POST	`/api/spend/perdiem`	administrator
GET	`/api/spend/rates`	signed in

sso 2

Method	Path	Access
GET	`/api/sso`	signed in
POST	`/api/sso/accounts`	signed in

statfile 20

Method	Path	Access
GET	`/api/statfile/corridors`	signed in
PUT	`/api/statfile/corridors/:key`	administrator
POST	`/api/statfile/filings/:id/prepare`	administrator
GET	`/api/statfile/leg`	signed in
POST	`/api/statfile/leg`	administrator
GET	`/api/statfile/leg/:id`	signed in
POST	`/api/statfile/leg/:id/delete`	administrator
POST	`/api/statfile/leg/:id/kat`	administrator
POST	`/api/statfile/leg/:id/rollback`	administrator
POST	`/api/statfile/leg/:id/schedule`	administrator
GET	`/api/statfile/leg/calendar`	signed in
POST	`/api/statfile/leg/snapshot`	administrator
POST	`/api/statfile/leg/tick`	administrator
POST	`/api/statfile/selftest`	administrator
GET	`/api/statfile/submissions`	signed in
GET	`/api/statfile/submissions/:id`	signed in
GET	`/api/statfile/submissions/:id/artefact`	signed in
POST	`/api/statfile/submissions/:id/poll`	administrator
POST	`/api/statfile/submissions/:id/record`	administrator
POST	`/api/statfile/submissions/:id/submit`	administrator

statout 13

Method	Path	Access
GET	`/api/statout/filings`	signed in
GET	`/api/statout/filings/:id/csv`	signed in
POST	`/api/statout/filings/:id/file`	administrator
GET	`/api/statout/filings/:id/pdf`	signed in
GET	`/api/statout/forms`	signed in
POST	`/api/statout/generate`	administrator
GET	`/api/statout/ids-coverage`	signed in
GET	`/api/statout/ids/:employeeId`	signed in
PUT	`/api/statout/ids/:employeeId`	administrator
GET	`/api/statout/kat`	administrator
POST	`/api/statout/kat`	administrator
DELETE	`/api/statout/kat/:id`	administrator
POST	`/api/statout/kat/run`	administrator

succession 6

Method	Path	Access
GET	`/api/succession`	signed in
POST	`/api/succession`	administrator
DELETE	`/api/succession/:id`	administrator
GET	`/api/succession/:id/successors`	signed in
POST	`/api/succession/:id/successors`	administrator
DELETE	`/api/succession/successors/:sid`	administrator

system-email 2

Method	Path	Access
GET	`/api/system-email`	administrator
PUT	`/api/system-email`	administrator

talent 2

Method	Path	Access
GET	`/api/talent`	signed in
PUT	`/api/talent/:employee_id`	administrator

taxengine 10

Method	Path	Access
POST	`/api/taxengine/calc`	signed in
DELETE	`/api/taxengine/country/:code`	administrator
GET	`/api/taxengine/country/:code`	signed in
PUT	`/api/taxengine/country/:code`	administrator
POST	`/api/taxengine/country/:code/bands`	administrator
POST	`/api/taxengine/country/:code/social`	administrator
GET	`/api/taxengine/coverage`	signed in
POST	`/api/taxengine/import`	administrator
POST	`/api/taxengine/live`	administrator
GET	`/api/taxengine/workbook`	signed in

timerules 7

Method	Path	Access
GET	`/api/timerules`	administrator
POST	`/api/timerules`	administrator
GET	`/api/timerules/attestation`	signed in
GET	`/api/timerules/pay`	signed in
POST	`/api/timerules/pay/:id/void`	administrator
GET	`/api/timerules/preview/:tsId`	signed in
POST	`/api/timerules/recompute/:tsId`	administrator

timesheets 5

Method	Path	Access
GET	`/api/timesheets`	signed in
POST	`/api/timesheets`	signed in
GET	`/api/timesheets/:id`	signed in
POST	`/api/timesheets/:id/approve`	administrator
POST	`/api/timesheets/:id/submit`	signed in

total-rewards 1

Method	Path	Access
GET	`/api/total-rewards/:employeeId`	signed in

username 1

Method	Path	Access
POST	`/api/username/forgot`	public

users 6

Method	Path	Access
GET	`/api/users`	administrator
POST	`/api/users`	administrator
DELETE	`/api/users/:id`	administrator
PUT	`/api/users/:id`	administrator
GET	`/api/users/:id/roles`	administrator
PUT	`/api/users/:id/roles`	administrator

vms 7

Method	Path	Access
GET	`/api/vms/overview`	signed in
POST	`/api/vms/sows`	administrator
POST	`/api/vms/sows/:id/milestone/:mid`	administrator
POST	`/api/vms/vendors`	administrator
POST	`/api/vms/workers`	administrator
POST	`/api/vms/workers/:id/activate`	administrator
POST	`/api/vms/workers/:id/end`	administrator

voice 7

Method	Path	Access
POST	`/api/voice/actions`	signed in
PUT	`/api/voice/actions/:id`	signed in
GET	`/api/voice/drivers`	signed in
GET	`/api/voice/surveys`	signed in
POST	`/api/voice/surveys`	signed in
PUT	`/api/voice/surveys/:id`	signed in
GET	`/api/voice/surveys/:id/results`	signed in

wellness 3

Method	Path	Access
GET	`/api/wellness/programs`	signed in
POST	`/api/wellness/programs`	signed in
GET	`/api/wellness/utilisation`	signed in