Skip to main content
Creating a Planday API app requires an Administrator account with access to all departments, on a Plus, Pro, or Enterprise subscription.

​
Creating an API application

Planday exposes its API through an app you create in your own Planday portal. Creating the app registers StackOne’s redirect URL and defines which data the integration may reach.

1

Sign in to Planday

Sign in to your Planday account.

  • Type your email address under Enter your email and click Continue. Planday resolves your company portal from your email address and signs you in there.
  • Portal address format: https://{yourcompany}.planday.com
  • If your business is not on Planday yet, use Create new organization on the same page before you continue.
The Planday log in page with the email field and the Continue button highlighted
2

Open Planday settings

Click Settings in the top navigation bar.

The Planday home page with Settings highlighted in the top navigation bar
3

Open API access

In the left sidebar, select API access under Integrations.

  • The Integrations group sits near the bottom of the sidebar, below Payroll — scroll the sidebar down to reach it.
  • Do not use the Integrations card on the Settings Overview page. That card opens the integrations overview, not API access.
The Settings page with the Integrations group and API access highlighted in the left sidebar
4

Create a new app

On the API access page, click Create app.

  • Use Connect app only to connect to an app that already exists.
The API access page with the Create app button highlighted
5

Fill in the application details

Complete the General section of the New Application dialog.

  • Title: StackOne Integration
  • Redirect URLs: https://api.stackone.com/connect/oauth2/planday/callback
  • Use Add new URL only if you need to register more than one redirect URL.
The New Application dialog with the Title and Redirect URLs fields highlighted

​
Configuring scopes

Scopes define the permission level for your connected applications to access Planday data. The Scopes section of the New Application dialog lists every resource as a row, with All, Read, Create, Update and Delete columns.

1

Select the permissions to grant

Enables actions: Approve Absence Request, Approve Shift, Assign Shift To Employee, Change Employee Username, Create Absence Adjustment, Create Accrued Account Type, Create Department, Create Employee, Create Employee Group, Create Or Update Employee Period Salary, Create Or Update Revenue, Create Position, Create Shift, Create Shift Type, Create Skill, Create Transaction, Deactivate Employee, Decline Absence Record, Delete Account Type, Delete Department, Delete Employee Group, Delete Position, Delete Revenue, Delete Shift, Delete Skill, Deny Absence Request, Get Absence Records, Get Absence Request Draft, Get Account Balance, Get Accrued Account Type, Get Department By ID, Get Employee By ID, Get Employee Field Definition, Get Employee Group By ID, Get Employee Pay Rates For All Groups, Get Employee Pay Rates In Employee Group, Get Employee Period Salary, Get Employee Salary Allocation, Get Payroll Data, Get Position By ID, Get Revenue Records, Get Shift By ID, Invite Employee, List Absence Accounts, List Absence Adjustments, List Absence Requests, List Absence Types, List Account Transactions, List Account Types, List Available Positions, List Available Shifts, List Deactivated Employees, List Departments, List Employee Groups, List Employee Shifts For Today, List Employee Types, List Of Employees, List Punch Clock Records, List Salary Types, List Shift Types, List Skills, List Supervisors, Reactivate Employee, Submit Absence Request, Update Accrued Account Type, Update Department, Update Employee, Update Employee Group, Update Employee Group Pay Rates, Update Position, Update Shift, Update Shift Type, Update Skill

Choose the scopes StackOne should request. Each scope corresponds to one resource row and one column in the Planday Scopes grid.

2

Select the matching boxes in the grid

Tick the columns listed below on each resource row. Ticking All on a row selects every column that row offers.

  • Department — Read, Create, Update, Delete
  • Employee — Read, Create, Update
  • Employee Group — Read, Create, Update, Delete
  • Employee Type — Read
  • Skill — Read, Create, Update, Delete
  • Punchclock Shift — Read
  • Revenue — Read, Create, Delete
  • Shift — Read, Create, Update, Delete
  • Shift Position — Read, Create, Update, Delete
  • Shift Type — Read, Create, Update
  • Payroll — Read
  • Absence — Read, Create, Update
  • Absence Settings — Read, Create, Update, Delete
  • Pay Rates — Read, Update
  • Salaries — Read, Update
The Scopes grid with the HR resources ticked and the All, Read, Create, Update and Delete columns visible
3

Verify no other resources are selected

Grant only the permissions the integration needs, and leave every other row unticked.

  • Under HR, leave Bank Account, Birth Date, Employee History and Social Security Number clear.
  • Leave Time And Cost, Contract Rules, Data Center, Security Group Membership and Security Groups clear.
  • The (deactivate) box on the Employee row is not required.
The Payroll, Absence and Pay scope groups ticked, with Contract rules, Data Center and Security group membership left clear
4

Save the application

Click Save at the top of the New Application dialog.

  • Set the scopes before you authorize the app. On an app that has already been authorized, Show details presents the scopes read-only.
The New Application dialog with the Save button highlighted

​
Authorizing the application

A new app is created without a token. Authorizing it grants the permissions you selected and issues the token StackOne uses to call the Planday API.

1

Authorize the new app

On the API access page, find the StackOne Integration tile and click Authorise.

  • Until the app is authorized, the tile shows an Application ID but no Token.
The StackOne Integration tile with the Authorise button highlighted
2

Confirm the requested permissions

Planday shows Allow access to your Planday account listing everything the app Would like to do. Review the list and click Authorize.

  • The tile then reads Authorised, and a Token appears below the Application ID.
The Planday consent screen listing the requested permissions with the Authorize button highlighted

​
Retrieving your credentials

The authorized tile carries both values StackOne needs. Planday hides each one behind dots, so copy them with the copy icon rather than reading them off the screen.

1

Copy the Application ID

On the StackOne Integration tile, copy the Application ID and store it securely for use later.

  • Application ID — Planday’s name for the OAuth client ID. It is a 36-character UUID. Copy it into the Application ID field in the StackOne Connector profile.
  • Click the copy icon beside the field to copy its value, or the eye icon to reveal it first.
  • The Token on the tile is for Planday’s own refresh-token flow. StackOne obtains its own token when you authorize the connection, so you do not need to copy it.
  • Revoke on the tile withdraws the authorization and breaks the connection.
  • Scopes in the StackOne Connector profile is optional. Leave it empty to request the connector’s full scope list, or enter a space-separated subset — it must always include openid and offline_access.
The authorized StackOne Integration tile showing the Application ID and Token fields

​
Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for Planday:
1

Navigate to Connector Profiles

Login to StackOne and navigate to Connector Profiles
2

Create New Connector Profile

  • Click + Connector Profile
  • Search for and select Planday
  • Select Type as OAuth 2.0
  • Fill out the fields using details retrieved from your provider:
    • Application ID
    • Scopes (Optional)
  • (Optional) Select Actions to be enabled for this Connector Profile
  • Click Create profile
Congratulations! The new Connector Profile will now show up in your project ready to be used. You can now continue to Link Accounts for Planday.