An Overview of the Personio Public API

This article provides an overview of Personio's two Public Application Programming Interfaces (API), the Recruiting API, and the Personnel Data API.

 

What are Public APIs in Personio?

An API is a connection between two interfaces, allowing data to be exchanged between the two systems. With this, you can build connections yourself between Personio and your own system, or set up integrations with third-party providers that are available in the Personio Marketplace. Personio offers two Public APIs: Recruiting and Personnel Data.

 

About the Personio Recruiting API

 

The Recruiting API allows the exchange of data concerning positions and candidates. For this Public API, your credentials are generated by the system and available in your account. To access them, go to Settings > INTEGRATIONS > API credentials and click on your Recruiting API key.

 

What can you do with it?

  1. Transfer candidate data to Personio (Credentials required)
    ▶︎
    Automatically transfer applications that were sent to your company career page into your Personio account and create a candidate profile.
    ▶︎ Automatically transfer candidate and application-related data, such as candidate name, application date, etc., to Personio.

    Learn more about transmitting candidate data to your Personio account.
  2. Transfer application documents to Personio (Credentials required)
    ▶︎ 
    Automatically upload application documents that were sent to your company career page into the respective candidate profile in Personio.

  3. Retrieve open positions via XML (Available via youraccount.jobs.personio.de/xml)
    ▶︎
    Via XML, you can pull data from positions that you published in Personio, and display it on your own company career page.

    Learn more about integrating positions from Personio into your company website via XML.

 

About the Personio Personnel Data API

 

The Personnel Data API allows the exchange of information concerning employee data, documents, projects, attendances, and absences. For this Public API, you need to generate new credentials for each new integration you set up. To generate new API credentials, go to Settings > INTEGRATIONS > API credentials and click Generate new credentials. Learn more about How to Generate and Manage API Credentials for Personnel Data.

 

What can you do with it?

  1. Send and receive employee data
    ▶︎
    Allow third-party systems to pull employee data from Personio.
    ▶︎ Create new employees in Personio
    ▶︎ Update existing employee data in Personio.

    Example: You can use the MS Teams integration to inform your employees of a selected channel about anniversaries and birthdays. Learn more about our Integration with MS Teams.

  2. Attendances
    ▶︎ Allow third-party systems to pull attendance data (incl. project ID) from Personio.
    ▶︎ Create new attendances in Personio.
    ▶︎ Update existing attendances in Personio.
    ▶︎ Delete attendances in Personio.

    Example: You can use the askDante integration to track your employees attendances. Data tracked in this application on start- and end-times, as well as the breaks from the attendance, can then be transferred into Personio. Learn more about our Integration with askDante.

  3. Projects
    ▶︎ Allow third-party systems to pull projects data from Personio.
    ▶︎ Create new projects in Personio.
    ▶︎ Update existing projects in Personio.
    ▶︎ Delete projects in Personio.

    Example: You can use the ZEP integration to track your employees attendances and time spent on specific projects. Data tracked in this application on the time that was spent on specific projects can then be transferred into Personio. Learn more about our Integration with ZEP.

  4. Absences
    ▶︎ Allow third-party systems to pull absence data from Personio.
    ▶︎ Create new absences in Personio.
    ▶︎ Delete absences in Personio.

    Example: You can use the Slack integration to enable your employees to request an absence directly from Slack. Learn more about our Integration with Slack.

  5. Documents
    ▶︎ Allow third-party systems to pull document categories data from Personio. This is necessary to be able to perform the below.
    ▶︎ Send a document to a Personio employee profile.

    Example: You can use the Pento integration to receive payslips from Pento and store them in the respective employee profile. Learn more about our Integration with Pento.

 

Technical documentation

All the documentation for our Public API, including endpoints, information about the precise data transferred and technical tutorials, is available in our Developer Hub.

Comments

0 comments

Article is closed for comments.

    Topics of this article