Contents
Overview
The Betterworks API allows applications to access and send Betterworks data using GET and POST calls. GET refers to accessing data from Betterworks (viewing a record). POST refers to sending data to Betterworks (updating a record).
GET and POST:
- User data (e.g., manager change, title change, etc.)
- Goal and milestone data
GET only:
- Conversation data
- Feedback data
- Recognition data
- Calibration data (including cycles and talent records)
Note: We recommend generating and sending a unique X-Request-ID header value for each public API call. If an error arises, this will make future troubleshooting easier because the Betterworks Support Team can search for the unique value.
Create an API Key
Any application can use the Betterworks API as long as every call contains an active API key. API keys are tied to users. As a result, the calls a user can perform and the data returned depend on the permissions of the key holder. A Super Admin has complete access, while users in other roles (e.g., HR Admin and Admin) have less. As a result, if a user cannot access certain information in the Betterworks user interface, they will not be able to access it via the Betterworks API either.
- Log in to Betterworks.
- Click Admin (bottom of the left-side panel).
- Click Platform Configuration.
- Select Integrations from the drop-down menu.
- Click API (top tab).
- Enter the API key details.
- Click Generate Key.
- Copy the API key.
- Enter the API key into your API client.
Documentation
Our developer documentation will help you determine which calls to use for your needs.
FAQs
I have an active API key. Why am I unable to perform certain calls?
The calls a user can perform, and the data returned, depend on the permissions of the key holder. A Super Admin has complete access, while users in other roles (e.g., HR Admin and Admin) have less. As a result, if a user cannot access certain information in the Betterworks user interface, they will not be able to access it via the Betterworks API either.