Planday Developer
Getting startedGuidesAPI
Visit our website
Getting started
OverviewAuthorizationAuthorization code flowAPI SupportBecoming an Integration partnerRegion-specific requestsRelease notes
Guides
API

Getting started

Welcome to Planday, we're happy to see you here. You'll start building powerful integrations to Planday, by using our API, in no time! Read about the basics below and then browse through the documentation to learn more about integrating to Planday and explore our APIs.

1. Get started with Planday

  • Request a demo portal which you can use for development and testing of your integration. To request a demo portal, fill the following form.

2. Learn about our API basics

  • Access to the Planday's API is secured by a standard Oauth2 flow with a bearer token. Learn more under Authentication. Choose whether users should connect your integration manually via Settings in Planday or using our auth flow for a more seamless experience.

  • Planday's REST api follows the standard structure of handling entity ID in the JSON response model. All request and response data have to be in JSON. Our API is separated into several domains (HR, Absence etc.). Explore all domains and endpoints by navigating to the API section.

  • Most endpoints come with pagination and return a max of 50 records per page. If you handle your API calls using offset, you should be good to go.

  • In order to prevent unintended issues, our default rate limits will ensure top performing environments.

    • Requests per second: 500
    • Requests per minute: 10000
  • If you’d like to get our Postman collection, request it by emailing us at apisupport@planday.com.

3. Set up your test app for OpenAPI access

  • Once you get access to your portal, navigate to Settings → API access and use the Create app button to create an application you will use for development and testing. If you already know what scopes your integration needs, choose only the desired scopes. If you are unsure what scopes will be necessary, choose all scopes for your test app (new scopes cannot be added once the app is created) and don't create your production app yet. Once you're done with development, go back and evaluate what is the minimal list of scopes your production app will require.
  • Authorize the app on the portal and start with development.
  • In case of any questions or issues, reach out to us at apisupport@planday.com.
  • Use our Set Up Your Business guide to make the portal your own.

4. Become a certified partner (applies to integrations intended for general availability, not custom integrations)

If you'd like to become an Integration Partner, fill out the following form. One of our partnership managers will reach out to you shortly to book a demo where you’ll be asked to show the integration’s setup process and functionality.
Read more about the process on the dedicated page.