Get started with PeopleForce's API reference guide
Generating API key
Go to Settings → Open API keys (bottom of the page) → Generate API key.
Creating a key allows users with this key to retrieve or change data in your company account via PeopleForce API. If you want to restrict users from making changes to viewing employee Compensation details you can change permission on the key to None.
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