Skip to main content

What can we help you with?

Back

Personio public APIs

This article provides an overview of the Personio public APIs, the functions of Personio API endpoints, and webhooks.

Explore Personio public APIs

Personio public APIs allow data exchange between Personio and other services or tools. They allow you to connect Personio to databases or integrate with third-party providers in the Personio Marketplace. These APIs offer several endpoints to retrieve and edit data from your Personio account.

The following list gives an overview of the capabilities of the Personio public APIs. Refer to the Developer Hub for more information.

API Functionality
Employees API
  • Retrieve employee data from Personio (including absence balance).
  • Create new employees in Personio
  • Update employee data in Personio.

Visit the Developer Hub for information about the system attributes supported for create and update.
Attendances API
  • Retrieve attendance data from Personio (including project details).
  • Create new attendances in Personio (with both start and end time, or only with start time).
  • Update attendances in Personio.
  • Delete attendances from Personio.
Attendance Projects API
  • Retrieve attendance data from Personio (including project details).
  • Create new attendances in Personio (with both start and end time, or only with start time).
  • Update attendances in Personio.
  • Delete attendances from Personio.
Absences API
  • Retrieve absence data from Personio (available for absences tracked in hours and days).
  • Create new absences in Personio (available for absences tracked in hours and days).
  • Delete absences in Personio (available for absences tracked in hours and days).
Documents API
  • Retrieve document categories and document metadata from Personio.
  • Download document files from Personio.
  • Send a document to a Personio employee profile.
  • Update document metadata in Personio.
  • Update documents from Personio.
Custom Reports API
  • Retrieve a list of all existing custom reports in your Personio account
  • Retrieve a list of all existing report table columns.
  • Retrieve data of a particular custom report in JSON format.

The Custom Reports API allows you to merge Personio data with other datasets or store it in a data warehouse for further processing. However, it can't create or edit custom reports.
Compensation API
  • Retrieve compensation values and types from Personio.
  • Post compensation values and types from Personio.
  • Create new compensation values and types in Personio (not possible for base salary).

API credentials

Learn more about how to generate and manage API credentials.

Explore webhooks

Webhooks are a specific part of Personio public APIs. Webhooks allow you to send information from Personio to your application or database whenever a certain event occurs. Learn more in the Developer Hub.

Personio provides webhooks for the following events:

  • person.created: When an employee’s profile is created in Personio.
  • person.deleted: When an employee’s profile is deleted in Personio.
  • person.updated: When certain parts of the employee’s profile are updated.
  • employment.updated: When employment-related parts of the employee profile are updated.

Technical documentation

Visit our Developer Hub for more information about Personio public APIs. It contains technical tutorials, endpoint information, and the precise data transferred.

The new Personio public API authentication endpoint, Webhooks, Compensation Data API endpoints, certain Documents API endpoints, and API endpoints in the testing phase are documented in the Developer Hub v2.

 

 

Help us improve. Is this page helpful?