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

# Justworks

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

![Justworks](https://stackone-logos.com/api/justworks/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/justworks/changelog.md)

[21 actions](#actions) · 1 auth method

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/justworks/guides/connector-profile/oauth-2-0.md)
>
> Requires a registered Partner API application with Justworks. Access tokens are valid for 24 hours with 30-day refresh t...

**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/justworks/guides/link-account/oauth-2-0.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

Scopes

Select all
|
Clear

company.bank\_account:read

company.basic:read

company.detail:read

deductions:read

deductions:write

member.basic:read

member.detail:read

payroll:read

paystub:read

time\_off:read

No scopes found

21 actions

ActionDescriptionRequired scopes

Get Company`justworks_get_company`

Retrieve company information including name, addresses, departments, and offices.

`company.basic:read`

Get Company Bank Account`justworks_get_company_bank_account`

Retrieve company bank account details.

`company.bank_account:read`

Get Company Business Info`justworks_get_company_business_info`

Retrieve company business information including entity identifiers and officers.

`company.detail:read`

List Company Custom Fields`justworks_list_company_custom_fields`

Retrieve all custom fields defined for the company.

`company.detail:read`

List Company Jurisdictions`justworks_list_company_jurisdictions`

Retrieve all jurisdictions where the company operates.

`company.detail:read``member.detail:read`

List Members`justworks_list_members`

Retrieve a paginated list of company members (employees and contractors).

`member.basic:read`

Get Member`justworks_get_member`

Retrieve a specific member by their ID.

`member.basic:read`

List Member Custom Field Values`justworks_list_member_custom_field_values`

Retrieve custom field values for a specific member.

`member.detail:read`

List Payrolls`justworks_list_payrolls`

Retrieve a paginated list of payrolls.

`payroll:read`

List Payroll Fees`justworks_list_payroll_fees`

Retrieve fees associated with a specific payroll.

`payroll:read`

List Payroll Paystubs`justworks_list_payroll_paystubs`

Retrieve paystubs for a specific payroll.

`paystub:read`

Get Paystub`justworks_get_paystub`

Retrieve a specific paystub by its ID.

`paystub:read`

List Deduction Types`justworks_list_deduction_types`

Retrieve all available deduction types.

`deductions:read`

List Deductions`justworks_list_deductions`

Retrieve a paginated list of deductions.

`deductions:read`

Create Deductions`justworks_create_deductions`

Create new deductions for company members.

`deductions:write`

Update Deductions`justworks_update_deductions`

Update existing deductions.

`deductions:write`

Cancel Deductions`justworks_cancel_deductions`

Cancel existing deductions.

`deductions:write`

Create Time Off Balances Report`justworks_create_time_off_balances_report`

Create a new time off balances report.

`time_off:read`

Get Time Off Balances Report`justworks_get_time_off_balances_report`

Retrieve a previously created time off balances report.

`time_off:read`

List Time Off Policies`justworks_list_time_off_policies`

Retrieve a paginated list of time off policies.

`time_off:read`

List Time Off Requests`justworks_list_time_off_requests`

Retrieve a paginated list of time off requests.

`time_off:read`


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