Use the API to Create Custom Integrations

For Pro subscriptions, Pingboard makes it easy for IT and Development teams to build custom apps, integrations, and sync with other platforms utilizing your employee data. 

What's an API?

API stands for Application Programming Interface – put simply, it's a framework that enables your tech team to get Pingboard to talk to other applications.

Our API powers our own mobile apps and is designed to be comprehensive and powerful. We want you to have everything you need to build great things with Pingboard!

Here are some examples of what you can accomplish by building on Pingboard's API:

  • Pull user data from Pingboard to build your company website's team page.

  • Pull vacation status data from Pingboard to sync to a third party HR or scheduling system.

  • Pull information about groups of users from Pingboard in order to provision or organize accounts on a third party system.

  • Push information from a third party app into a custom field in Pingboard.

  • Create Slack slash commands to access data in Pingboard quickly from your chat client.

Learn More

If you're on a Pro plan, you already have access to our API – you can find and access it on the API section of the Add-Ons page in the web app (Settings > Add-Ons > API).

You'll also find our API documentation on that page. Your tech team will need that documentation in order to use the API to build connections. You can also access that documentation here: Pingboard API Documentation

What next?

To start building an API integration for your Pingboard account, you'll need:

  1. Pro subscription to Pingboard.
  2. Admin status in both Pingboard and the app or site that you're trying to establish a connection to on the API.
  3. Our API Documentation.
  4. A Service Account for each connection you build on the API – you can create Service Accounts on the API page in Pingboard by clicking Manage Service Accounts, then New Service Account.
  5. (Optional) If you're using Pingboard's API to link Pingboard to other apps, you'll usually need access to your endpoint application's API as well.

Tip: If you hit any roadblocks or need some advice on what you're building, drop us a note at help@pingboard.com. We want to help you build great things with the Pingboard API!

Still need help? Let us know.