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

# Planday

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

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

v3.2.0[See changelog](https://docs.stackone.com/connectors/planday/changelog.md)

[79 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/planday/guides/connector-profile/oauth-2-0.md)
>
> Requires creating an API app in your Planday portal. Planday apps issue only an Application ID (the OAuth client ID) and...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/planday/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> No sign-in when connecting. Uses the Application ID and Token from an API app authorized in your own Planday portal, so...

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

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/planday/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

Scopes

Select all
|
Clear

absence:create

absence:read

absence:update

absencesettings:create

absencesettings:delete

absencesettings:read

absencesettings:update

department:create

department:delete

department:read

department:update

employee:create

employee:read

employee:update

employeegroup:create

employeegroup:delete

employeegroup:read

employeegroup:update

employeetype:read

payrates:read

payrates:update

payroll:read

punchclockshift:read

revenue:delete

revenue:read

revenue:set

salaries:read

salaries:update

shift:create

shift:delete

shift:read

shift:update

shiftposition:create

shiftposition:delete

shiftposition:read

shiftposition:update

shifttype:create

shifttype:read

shifttype:update

skill:create

skill:delete

skill:read

skill:update

No scopes found

79 actions

ActionDescriptionRequired scopes

List Of Employees`planday_list_employees`

Get a list of active employee profiles

`employee:read`

Get Employee By ID`planday_get_employee`

Get details of an employee's profile

`employee:read`

List Countries`planday_list_countries`

Get the list of countries in the system

`employee:read`

Get Employee Field Definition`planday_get_employee_field_definition`

Get a list of fields available when creating or updating an employee account

`employee:read`

Create Employee`planday_create_employee`

Create a new employee account based on provided parameters

`employee:create`

Update Employee`planday_update_employee`

Update an existing employee's information

`employee:update`

Deactivate Employee`planday_deactivate_employee`

Deactivate an employee account

`employee:update`

Reactivate Employee`planday_reactivate_employee`

Reactivate a previously deactivated employee account

`employee:update`

List Supervisors`planday_list_supervisors`

Retrieve a list of employees marked as supervisors

`employee:read`

Invite Employee`planday_invite_employee`

Invite an employee by sending an invitation email

`employee:create`

Change Employee Username`planday_change_employee_username`

Update an employee's username

`employee:update`

List Deactivated Employees`planday_list_deactivated_employees`

Get a paginated list of deactivated employees

`employee:read`

List Absence Accounts`planday_list_absence_accounts`

Returns all accounts filtered by account id, employee id, account type and status

`absence:read`

List Absence Adjustments`planday_list_absence_adjustments`

Returns adjustments of a specific accrued absence account

`absence:read`

Create Absence Adjustment`planday_create_absence_adjustment`

Create an adjustment to change a balance of an accrued absence account

`absence:create`

List Absence Types`planday_list_absence_types`

Get available absence types

`absence:read`

List Account Types`planday_list_account_types`

Get all available account types filtered by id, absence type and deleted state

`absencesettings:read`

Get Accrued Account Type`planday_get_accrued_account_type`

Get account types with absence type - Accrued

`absencesettings:read`

Delete Account Type`planday_delete_account_type`

Remove account type

`absencesettings:delete`

Update Accrued Account Type`planday_update_accrued_account_type`

Update account type definition of absence type Accrued

`absencesettings:update`

Create Accrued Account Type`planday_create_accrued_account_type`

Create new account type definition of absence type Accrued

`absencesettings:create`

Get Absence Records`planday_get_absence_records`

Returns absence records matching given criteria

`absence:read`

Decline Absence Record`planday_decline_absence_record`

Decline a specific absence record

`absence:update`

Submit Absence Request`planday_submit_absence_request`

Submit an absence request on behalf of an employee

`absence:create`

List Absence Requests`planday_list_absence_requests`

Get all absence requests, filter by employee and/or absence request status

`absence:read`

Approve Absence Request`planday_approve_absence_request`

Approve a specific absence request

`absence:create`

Deny Absence Request`planday_deny_absence_request`

Deny an absence request

`absence:create`

Get Account Balance`planday_get_account_balance`

Gets account balance for a specific account

`absence:read`

Get Absence Request Draft`planday_get_absence_request_draft`

Get an absence request draft that can be sent later to submit an absence request

`absence:create`

List Account Transactions`planday_list_account_transactions`

Returns all transactions for a given account in a given date

`absence:read`

Create Transaction`planday_create_transaction`

Create a new transaction for a TOIL account to adjust its balance

`absence:create`

List Employee Account Balances`planday_list_employee_account_balances`

Gets all absence account balances for the given employees on a certain date

`absence:read`

List Departments`planday_list_departments`

Get a list of departments

`department:read`

Get Department By ID`planday_get_department`

Get details of a department

`department:read`

Create Department`planday_create_department`

Create a new department

`department:create`

Update Department`planday_update_department`

Update details of a department

`department:update`

Delete Department`planday_delete_department`

Delete a department

`department:delete`

List Employee Groups`planday_list_employee_groups`

Get a list of employee groups

`employeegroup:read`

Get Employee Group By ID`planday_get_employee_group`

Get details of an employee group

`employeegroup:read`

Create Employee Group`planday_create_employee_group`

Create a new employee group

`employeegroup:create`

Update Employee Group`planday_update_employee_group`

Update details of an employee group

`employeegroup:update`

Delete Employee Group`planday_delete_employee_group`

Delete an employee group

`employeegroup:delete`

List Employee Types`planday_list_employee_types`

Get a list of available employee types

`employeetype:read`

List Skills`planday_list_skills`

Get a list of skills on the portal

`skill:read`

Create Skill`planday_create_skill`

Create a new skill on the portal

`skill:create`

Update Skill`planday_update_skill`

Update the name, description and time limited status of a skill

`skill:update`

Delete Skill`planday_delete_skill`

Delete a skill by providing the skill id

`skill:delete`

List Available Shifts`planday_list_shifts`

Returns paginated list of available shifts matching given criteria

`shift:read`

Get Shift By ID`planday_get_shift`

Returns shift by shift id

`shift:read`

Create Shift`planday_create_shift`

Create a shift

`shift:create`

Update Shift`planday_update_shift`

Update a shift

`shift:update`

Delete Shift`planday_delete_shift`

Delete an existing shift

`shift:delete`

Approve Shift`planday_approve_shift`

Approve a shift that is ready for payroll processing

`shift:update`

Assign Shift To Employee`planday_assign_shift`

Assign a shift to a specific employee or set it to Open

`shift:update`

Publish Draft Shifts`planday_publish_draft_shifts`

Publishes draft shifts of a department, making them visible to employees

`shift:update`

List Shift Types`planday_list_shift_types`

Returns paginated list of available shift types

`shifttype:read`

Create Shift Type`planday_create_shift_type`

Create a new shift type

`shifttype:create`

Update Shift Type`planday_update_shift_type`

Update an existing shift type

`shifttype:update`

List Available Positions`planday_list_positions`

Returns paginated list of available positions

`shiftposition:read`

List Available Sections`planday_list_sections`

Returns paginated list of available sections

`shiftposition:read`

Create Position`planday_create_position`

Create a position

`shiftposition:create`

Get Position By ID`planday_get_position`

Returns position by provided id

`shiftposition:read`

Update Position`planday_update_position`

Update a position

`shiftposition:update`

Delete Position`planday_delete_position`

Delete position by provided id

`shiftposition:delete`

Get Employee Pay Rates In Employee Group`planday_get_employee_group_employee_payrates`

Return pay rates for an employee in a specified employee group

`payrates:read`

Update Employee Group Pay Rates`planday_update_employee_group_payrates`

Update employees pay rates in a given employee group

`payrates:update`

Get Employee Pay Rates For All Groups`planday_get_employee_payrates_all_groups`

Return pay rates of a given employee for all assigned employee groups

`payrates:read`

Get Employee Salary Allocation`planday_get_employee_salary_allocation`

Return salary allocation for a given employee id

`salaries:read`

Get Employee Period Salary`planday_get_employee_period_salary`

Return a Period Salary with a given employee id

`salaries:read`

Create Or Update Employee Period Salary`planday_create_or_update_employee_period_salary`

Create or update a Period Salary with a given employee id

`salaries:update`

List Salary Types`planday_list_salary_types`

Return available salary types

`salaries:read`

Get Payroll Data`planday_list_payroll`

Returns the payroll data matching given criteria including departments, time period, and shift status

`payroll:read`

Get Revenue Records`planday_list_revenue`

Get all revenue records matching the request criteria

`revenue:read`

Create Or Update Revenue`planday_create_or_update_revenue`

Create a new revenue record for a revenue unit on a given day or update an existing one

`revenue:set`

Delete Revenue`planday_delete_revenue`

Delete revenue for a given date and revenue unit

`revenue:delete`

List Revenue Units`planday_list_revenue_units`

Get all revenue units from the whole portal

`revenue:read`

List Revenue Units For Department`planday_list_department_revenue_units`

Get the revenue units of a given department

`revenue:read`

List Employee Shifts For Today`planday_list_employee_shifts_today`

Returns a list of all of today's Employee Shifts

`shift:read`

List Punch Clock Records`planday_list_punchclock_shifts`

Returns a list of all available Punch Clock records as specified in your parameters

`punchclockshift:read`


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