Planday · OAuth Scopes

Planday OAuth Scopes

OAuth 2.0 searched

Planday publishes 78 OAuth 2.0 scopes via the authorizationCode, clientCredentials, and refreshToken flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the Planday API on a user’s behalf.

Tokens are issued from https://id.planday.com/connect/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

CompanySaaSWorkforce ManagementSchedulingTime TrackingPayrollHuman ResourcesHospitalityRetailRESTOAuth2

Scopes: 78 Flows: authorizationCode, clientCredentials, refreshToken Method: searched

OAuth endpoints

Authorization URL
https://id.planday.com/connect/authorize

Token URL
https://id.planday.com/connect/token

Flows
authorizationCodeclientCredentialsrefreshToken

Scopes (78)

Scope	Description	Flows
openid	OpenID Connect authentication
plandayid	Planday identity claim
email	Access the user email claim
offline_access	Issue a refresh token for long-lived access
employee:read	Read employee details
employee:create	Create employees
employee:update	Update employee details
employee:deactivate	Deactivate employees
employee:history	Read employee history
employeetype:read	Read employee types
employeegroup:read	Read employee groups
employeegroup:create	Create employee groups
employeegroup:update	Update employee groups
employeegroup:delete	Delete employee groups
department:read	Read departments
department:create	Create departments
department:update	Update departments
department:delete	Delete departments
skill:read	Read skills
skill:create	Create skills
skill:update	Update skills
skill:delete	Delete skills
bankaccount:read	Read employee bank account details
bankaccount:create	Create employee bank account details
bankaccount:update	Update employee bank account details
birthdate:read	Read employee birthdate
birthdate:create	Set employee birthdate
birthdate:update	Update employee birthdate
ssn:read	Read employee social security number
ssn:create	Set employee social security number
ssn:update	Update employee social security number
shift:read	Read scheduled shifts
shift:create	Create shifts
shift:update	Update shifts
shift:delete	Delete shifts
shifttype:read	Read shift types
shifttype:create	Create shift types
shifttype:delete	Delete shift types
shiftposition:read	Read shift positions
shiftposition:create	Create shift positions
shiftposition:update	Update shift positions
shiftposition:delete	Delete shift positions
timeandcost:read	Read time and cost data for shifts
punchclockshift:read	Read punch clock shift entries
punchclockshift:create	Create punch clock shift entries
punchclockkioskdevice:read	Read punch clock kiosk devices
punchclockkioskdevice:create	Create punch clock kiosk devices
punchclockkioskdevice:delete	Delete punch clock kiosk devices
punchclockkioskprofile:read	Read punch clock kiosk profiles
punchclockkioskprofile:create	Create punch clock kiosk profiles
absence:read	Read absence records
absence:create	Create absence records
absence:update	Update absence records
absencesettings:read	Read absence settings
absencesettings:create	Create absence settings
absencesettings:update	Update absence settings
absencesettings:delete	Delete absence settings
revenue:read	Read revenue data
revenue:set	Set revenue data
revenue:update	Update revenue data
revenue:delete	Delete revenue data
payroll:read	Read payroll reporting data
payrates:read	Read employee pay rates
payrates:update	Update employee pay rates
salaries:read	Read employee salaries
salaries:update	Update employee salaries
contractrules:read	Read employee contract rules
contractrules:update	Update employee contract rules
portal:create	Create portal connection details
securitygroups:read	Read security groups
securitygroupmembership:read	Read security group membership
securitygroupmembership:update	Update security group membership
securitygroupmembership:delete	Delete security group membership
datacenter:read	Read data center details
datacenter:create	Create data center details
platform_access_token	Issue a platform access token
access_token	Issue an access token
impersonate	Impersonate a user (privileged)

📄 Provider scope reference: https://openapi.planday.com/gettingstarted/authorization-flow/

Source

OAuth Scopes

generated: '2026-07-20'
method: searched
source: https://id.planday.com/.well-known/openid-configuration
docs: https://openapi.planday.com/gettingstarted/authorization-flow/
notes: 'Scopes captured verbatim from the OpenID Connect discovery document''s
  scopes_supported array. Scopes must be selected when an app is created in Planday
  (Settings -> API access -> Create app); new scopes cannot be added after creation.
  Descriptions are derived from the resource:action scope naming convention.'
schemes:
- name: OAuth2
  type: oauth2
  source: https://id.planday.com/.well-known/openid-configuration
  flows:
  - flow: authorizationCode
    authorizationUrl: https://id.planday.com/connect/authorize
    tokenUrl: https://id.planday.com/connect/token
  - flow: clientCredentials
    tokenUrl: https://id.planday.com/connect/token
  - flow: refreshToken
    tokenUrl: https://id.planday.com/connect/token
scopes:
- {scope: openid, description: OpenID Connect authentication}
- {scope: plandayid, description: Planday identity claim}
- {scope: email, description: Access the user email claim}
- {scope: offline_access, description: Issue a refresh token for long-lived access}
- {scope: 'employee:read', description: Read employee details}
- {scope: 'employee:create', description: Create employees}
- {scope: 'employee:update', description: Update employee details}
- {scope: 'employee:deactivate', description: Deactivate employees}
- {scope: 'employee:history', description: Read employee history}
- {scope: 'employeetype:read', description: Read employee types}
- {scope: 'employeegroup:read', description: Read employee groups}
- {scope: 'employeegroup:create', description: Create employee groups}
- {scope: 'employeegroup:update', description: Update employee groups}
- {scope: 'employeegroup:delete', description: Delete employee groups}
- {scope: 'department:read', description: Read departments}
- {scope: 'department:create', description: Create departments}
- {scope: 'department:update', description: Update departments}
- {scope: 'department:delete', description: Delete departments}
- {scope: 'skill:read', description: Read skills}
- {scope: 'skill:create', description: Create skills}
- {scope: 'skill:update', description: Update skills}
- {scope: 'skill:delete', description: Delete skills}
- {scope: 'bankaccount:read', description: Read employee bank account details}
- {scope: 'bankaccount:create', description: Create employee bank account details}
- {scope: 'bankaccount:update', description: Update employee bank account details}
- {scope: 'birthdate:read', description: Read employee birthdate}
- {scope: 'birthdate:create', description: Set employee birthdate}
- {scope: 'birthdate:update', description: Update employee birthdate}
- {scope: 'ssn:read', description: Read employee social security number}
- {scope: 'ssn:create', description: Set employee social security number}
- {scope: 'ssn:update', description: Update employee social security number}
- {scope: 'shift:read', description: Read scheduled shifts}
- {scope: 'shift:create', description: Create shifts}
- {scope: 'shift:update', description: Update shifts}
- {scope: 'shift:delete', description: Delete shifts}
- {scope: 'shifttype:read', description: Read shift types}
- {scope: 'shifttype:create', description: Create shift types}
- {scope: 'shifttype:delete', description: Delete shift types}
- {scope: 'shiftposition:read', description: Read shift positions}
- {scope: 'shiftposition:create', description: Create shift positions}
- {scope: 'shiftposition:update', description: Update shift positions}
- {scope: 'shiftposition:delete', description: Delete shift positions}
- {scope: 'timeandcost:read', description: Read time and cost data for shifts}
- {scope: 'punchclockshift:read', description: Read punch clock shift entries}
- {scope: 'punchclockshift:create', description: Create punch clock shift entries}
- {scope: 'punchclockkioskdevice:read', description: Read punch clock kiosk devices}
- {scope: 'punchclockkioskdevice:create', description: Create punch clock kiosk devices}
- {scope: 'punchclockkioskdevice:delete', description: Delete punch clock kiosk devices}
- {scope: 'punchclockkioskprofile:read', description: Read punch clock kiosk profiles}
- {scope: 'punchclockkioskprofile:create', description: Create punch clock kiosk profiles}
- {scope: 'absence:read', description: Read absence records}
- {scope: 'absence:create', description: Create absence records}
- {scope: 'absence:update', description: Update absence records}
- {scope: 'absencesettings:read', description: Read absence settings}
- {scope: 'absencesettings:create', description: Create absence settings}
- {scope: 'absencesettings:update', description: Update absence settings}
- {scope: 'absencesettings:delete', description: Delete absence settings}
- {scope: 'revenue:read', description: Read revenue data}
- {scope: 'revenue:set', description: Set revenue data}
- {scope: 'revenue:update', description: Update revenue data}
- {scope: 'revenue:delete', description: Delete revenue data}
- {scope: 'payroll:read', description: Read payroll reporting data}
- {scope: 'payrates:read', description: Read employee pay rates}
- {scope: 'payrates:update', description: Update employee pay rates}
- {scope: 'salaries:read', description: Read employee salaries}
- {scope: 'salaries:update', description: Update employee salaries}
- {scope: 'contractrules:read', description: Read employee contract rules}
- {scope: 'contractrules:update', description: Update employee contract rules}
- {scope: 'portal:create', description: Create portal connection details}
- {scope: 'securitygroups:read', description: Read security groups}
- {scope: 'securitygroupmembership:read', description: Read security group membership}
- {scope: 'securitygroupmembership:update', description: Update security group membership}
- {scope: 'securitygroupmembership:delete', description: Delete security group membership}
- {scope: 'datacenter:read', description: Read data center details}
- {scope: 'datacenter:create', description: Create data center details}
- {scope: platform_access_token, description: Issue a platform access token}
- {scope: access_token, description: Issue an access token}
- {scope: impersonate, description: Impersonate a user (privileged)}