Include our headers in your requests

Personio introduces a set of headers that you should include in your requests, so that we can understand the usage of your integration. This can help us understand your requirements and needs in order to provide more features and add value to our API. Headers enable quicker debugging and account-specific issue resolution.

It is very strongly recommended that headers be included on every incoming request to our API.

The values for the X-Personio-Partner-ID and X-Personio-App-ID can be defined by you, but should represent your company name and application name.

For Marketplace integration partners:
Personio very strongly recommends that you pass an acceptable value for both the X-Personio-Partner-ID and the X-Personio-App-ID headers in your requests.

For customers:
Personio very strongly recommends that you pass an acceptable value for the X-Personio-App-ID only. Do note that without headers we may be unable to troubleshoot and/or support API-related queries

HeaderDescriptionExample
X-Personio-Partner-IDThe partner identifierX-Personio-Partner-ID: ACME
X-Personio-App-IDThe application identifier that integrates with Personio.X-Personio-App-ID: SLACK

Values MUST follow the UPPER_SNAKE_CASE format. For example MY_APPLICATION, ACME are valid values.

TIPS: Please make sure you keep those values consistent across your requests and thereby enable quicker issue resolution