The Workforce Planning API provides access to positions in your company.
Note:If you have not purchased Workforce planning, you will not have access to this feature. To learn more, see Workforce planning.
Before you begin
- Read Explore Workforce Planning API to learn how to use the API.
Permissions required
To use the Workforce planning endpoints, make sure to set up the following permissions:
Action | Permission |
---|---|
Metadata and Search endpoints | Features > Workforce planning > Position management > Manage positions |
Create positions | Features > Workforce planning > Position management > Add and edit multiple openings in a position |
Budget endpoints | Features > Workforce planning > Position management > Position budget settings |
Rate limiting
Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.
Below is a table detailing the rate limits for each endpoint in the Hiring endpoints.
Method | Endpoint | Limit per minute |
---|---|---|
GET | Get all positions fields | 50 |
GET | Get all position opening fields | 50 |
GET | Get all position budget fields | 50 |
POST | Read company positions | 100 |
POST | Read company positions openings | 100 |
POST | Read company positions budgets | 100 |
POST | Create Position | 10 |
POST | Create Position opening | 10 |
PATCH | Update Position | 10 |
PATCH | Update Position Opening | 10 |
DEL | Delete Position Opening | 10 |
POST | Create Position Budget | 10 |
PATCH | Update Position Budget | 10 |
PATCH | Cancel Position | 10 |