> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SD Worx

> How to set up the SD Worx connector, plus the actions that are available.

![SD Worx](https://stackone-logos.com/api/sdworx/filled/svg)

Betav0.3.0[See changelog](https://docs.stackone.com/connectors/sdworx/changelog.md)

[76 actions](#actions) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/sdworx/guides/connector-profile/oauth-2-0.md)
>
> SD Worx Cobra API uses OAuth 2.0 authorization code flow for user-delegated access.

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/sdworx/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> SD Worx Cobra API uses OAuth 2.0 client credentials for server-to-server access.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/sdworx/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/sdworx/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

OAuth 2.0 (Client Credentials)

No auth methods found

76 actions

ActionDescription

List Persons`sdworx_list_persons`

Retrieve a list of persons

Get Person`sdworx_get_person`

Retrieve a single person by ID

Create Person`sdworx_create_person`

Create a new person

Update Person`sdworx_update_person`

Update an existing person by ID

Patch Person`sdworx_patch_person`

Partially update a person by ID

Delete Person`sdworx_delete_person`

Delete a person by ID

List Person Contracts`sdworx_list_person_contracts`

Retrieve a list of person contracts

Get Person Contract`sdworx_get_person_contract`

Retrieve a single person contract by ID

Create Person Contract`sdworx_create_person_contract`

Create a new person contract

Update Person Contract`sdworx_update_person_contract`

Update an existing person contract by ID

Patch Person Contract`sdworx_patch_person_contract`

Partially update a person contract by ID

Delete Person Contract`sdworx_delete_person_contract`

Delete a person contract by ID

List Person Leaves`sdworx_list_person_leaves`

Retrieve a list of person leaves

Get Person Leave`sdworx_get_person_leave`

Retrieve a single person leave by ID

Create Person Leave`sdworx_create_person_leave`

Create a new person leave

Update Person Leave`sdworx_update_person_leave`

Update an existing person leave by ID

Delete Person Leave`sdworx_delete_person_leave`

Delete a person leave by ID

List Departments`sdworx_list_departments`

Retrieve a list of departments

Get Department`sdworx_get_department`

Retrieve a single department by ID

Create Department`sdworx_create_department`

Create a new department

Update Department`sdworx_update_department`

Update an existing department by ID

Patch Department`sdworx_patch_department`

Partially update a department by ID

Delete Department`sdworx_delete_department`

Delete a department by ID

List Companies`sdworx_list_companies`

Retrieve a list of companies

Get Company`sdworx_get_company`

Retrieve a single company by ID

Create Company`sdworx_create_company`

Create a new company

List Organizations`sdworx_list_organizations`

Retrieve a list of organisations

Get Organization`sdworx_get_organization`

Retrieve a single organisation by ID

List Current Employments`sdworx_list_current_employments`

Retrieve a list of current employments

List Salary Employments`sdworx_list_salary_employments`

Retrieve a list of salary employments

Get Salary Employment`sdworx_get_salary_employment`

Retrieve a single salary employment by ID

Create Salary Employment`sdworx_create_salary_employment`

Create a new salary employment

Update Salary Employment`sdworx_update_salary_employment`

Update an existing salary employment by ID

Delete Salary Employment`sdworx_delete_salary_employment`

Delete a salary employment by ID

List Person Salaries`sdworx_list_person_salaries`

Retrieve a list of person salaries

Get Person Salary`sdworx_get_person_salary`

Retrieve a single person salary by ID

Create Person Salary`sdworx_create_person_salary`

Create a new person salary

Delete Person Salary`sdworx_delete_person_salary`

Delete a person salary by ID

List Salary Components`sdworx_list_salary_components`

Retrieve a list of salary components

Get Salary Component`sdworx_get_salary_component`

Retrieve a single salary component by ID

Create Salary Component`sdworx_create_salary_component`

Create a new salary component

Update Salary Component`sdworx_update_salary_component`

Update an existing salary component by ID

Delete Salary Component`sdworx_delete_salary_component`

Delete a salary component by ID

Get Address`sdworx_get_address`

Retrieve a single address by ID

Create Address`sdworx_create_address`

Create a new address

Delete Address`sdworx_delete_address`

Delete an address by ID

Get Payment Information`sdworx_get_payment_information`

Retrieve a single payment information by ID

Create Payment Information`sdworx_create_payment_information`

Create a new payment information

Delete Payment Information`sdworx_delete_payment_information`

Delete a payment information by ID

List Leave Entitlements`sdworx_list_leave_entitlements`

Retrieve a list of leave entitlements

Get Leave Entitlement`sdworx_get_leave_entitlement`

Retrieve a single leave entitlement by ID

List Functions`sdworx_list_functions`

Retrieve a list of functions

Get Function`sdworx_get_function`

Retrieve a single function by ID

Create Function`sdworx_create_function`

Create a new function

Delete Function`sdworx_delete_function`

Delete a function by ID

List Payrolls`sdworx_list_payrolls`

Retrieve a list of payrolls

Get Payroll`sdworx_get_payroll`

Retrieve a single payroll by ID

Get Payslip`sdworx_get_payslip`

Retrieve payslips for a person and year

List Runs`sdworx_list_runs`

Retrieve a list of runs

Get Run`sdworx_get_run`

Retrieve a single run by ID

List Calculated Salary Components`sdworx_list_calculated_salary_components`

Retrieve a list of calculated salary components

List Org Chart`sdworx_list_org_chart`

Retrieve a list of org chart

List Person Leave Entitlements`sdworx_list_person_leave_entitlements`

Retrieve a list of person leave entitlements

List Person Leave Hours`sdworx_list_person_leave_hours`

Retrieve a list of person leave hours

Create Person Document`sdworx_create_person_document`

Create a new person document

Delete Person Document`sdworx_delete_person_document`

Delete a person document by ID

Create Person Contact`sdworx_create_person_contact`

Create a new person contact

Create Person Time Schedule`sdworx_create_person_time_schedule`

Create a new person time schedule

Create Lease Car`sdworx_create_lease_car`

Create a new lease car

Create Cost Center Allocation`sdworx_create_cost_center_allocation`

Create a new cost center allocation

Get Position`sdworx_get_position`

Retrieve a single position by ID

List Cost Center Allocations`sdworx_list_cost_center_allocations`

Retrieve a list of cost center allocations

List Lease Cars`sdworx_list_lease_cars`

Retrieve a list of lease cars

List Person Contacts`sdworx_list_person_contacts`

Retrieve a list of person contacts

List Person Documents`sdworx_list_person_documents`

Retrieve a list of person documents

List Person Time Schedules`sdworx_list_person_time_schedules`

Retrieve a list of person time schedules


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.