Get started with PeopleForce's API reference guide
Generating API key
Go to Settings → Open API keys (bottom of the page) → Generate API key.
Make sure you create the right type of API key for your use case:
- Company API key - provides full access to the PeopleForce API and employee data with minimal restrictions.
- Career API key - can be used to display vacancies on your public website. These API keys can be used on a public-facing website.
How to use key
To use API key you need to pass it as a part of the request.
Include the key in a header parameter called X-API-KEY.
Example: X-API-KEY: 123
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
For more information check out our authentication guide