Easily Integrate
Personio's Data API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 29 SDK methods
Parameter
Pagination attribute to limit the number of employees returned per page.
Pagination attribute to identify the first item in the collection to return.
Find an employee with the given email address. The response is still a list, containing only the filtered employee. NOTE: when using the updated_since filter, the email filter is ignored.
A list of attributes that will be returned for the employees, ie. a projection of the employee fields and relationships. In case updated_since query parameter is used, this list will additionally be used to exclude the employees that had none of the provided attributes[] updated since updated_since, ie. a selection filter.
Filter to select and return only the employees that have been updated after updated_since. When it is used together with the attributes[] query parameter, the filter will select only the employees that have had any of the provided attributes[] updated since updated_since. The format is ISO 8601 (2022-12-24T08:15:30). NOTE: when using the updated_since filter, the email, limit, and offset parameters are ignored.
Examples with updated_since and attributes[]:
In an example company that has 17 employees:
?updated_since=2022-12-24T08:15:30
will yield 10 employees that were recently updated:
{
"success": true,
"metadata": {
"total_elements": 10,
"current_page": 0,
"total_pages": 10
},
"offset": 0,
"limit": 1,
"data": [
{
"type": "Employee",
"attributes": {
"id": {
"label": "ID",
"value": 1,
"type": "integer",
"universal_id": "id"
},
"first_name": {
"label": "First name",
"value": "Alexander",
"type": "standard",
"universal_id": "first_name"
},
"last_name": {
"label": "Last name",
"value": "Bergmann",
"type": "standard",
"universal_id": "last_name"
},
"email": {
"label": "Email",
"value": "alexander.bergmann@demo.com",
"type": "standard",
"universal_id": "email"
}
}
}, ...
],
...
...
}
?attributes[]=first_name
will yield all 17 employees:
{
"success": true,
"metadata": {
"total_elements": 17,
"current_page": 0,
"total_pages": 17
},
"offset": 0,
"limit": 1,
"data": [
{
"type": "Employee",
"attributes": {
"id": {
"label": "ID",
"value": 1,
"type": "integer",
"universal_id": "id"
},
"first_name": {
"label": "First name",
"value": "Alexander",
"type": "standard",
"universal_id": "first_name"
}
}
}
]
}
?attributes[]=first_name&updated_since=2022-12-24T08:15:30
will yield 3 employees, ones that had their first_name changed since 2022-12-24T08:15:30:
{
"success": true,
"metadata": {
"total_elements": 3,
"current_page": 0,
"total_pages": 3
},
"offset": 0,
"limit": 1,
"data": [
{
"type": "Employee",
"attributes": {
"id": {
"label": "ID",
"value": 1,
"type": "integer",
"universal_id": "id"
},
"first_name": {
"label": "First name",
"value": "Alexander",
"type": "standard",
"universal_id": "first_name"
}
}
}
]
} Response
Endpoint
Parameter
Response
Endpoint
Parameter
Numeric id of the employee
Response
Endpoint
Parameter
Numeric id of the employee
Response
Endpoint
Parameter
Numeric id of the employee
Response
Endpoint
Parameter
The partner identifier
The application identifier
Response
Please refer to /company/employees/attributes
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About Personio
Personio's all-in-one software makes HR processes as efficient and effective as possible so organizations can focus on what matters: people.