Articles in this section

Available Personio APIs

When you configure an export, import, or other type of flow step using the prebuilt Personio connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Personio API documentation. You can also create a composite endpoint for this application in HTTP mode.

API type: Personnel data

Resource

Endpoint

Export

Import

Absence period API: Absence periods (Beta)

Retrieve absence period by ID

X

Update absence period

X

Create absence period

X

Delete absence period

X

Absence period API: Absence periods breakdowns (Beta)

Get absence period breakdowns

X

Absence period API: Absence types (Beta)

Retrieve absence type by ID

X

List absence types

X

Absences

Provides a list of absence types for absences tracked in days and hours

X

Fetches absence periods for absences tracked in days

X

Deletes absence period data for absence types tracked in days

X

Gets an absence period for absences tracked in days

X

Fetches absence periods for absences tracked in hours

X

Deletes absence period data for absence types tracked in hours

X

Create a time-off

X

Create an absence period

X

Attendances

Fetch attendance data for the company employees

X

Add attendance data for the company employees

X

Delete attendance data for the company employees

X

Update attendance data for the company employees

X

Get attendance period

X

Delete an attendance period by ID

X

Update attendance period

X

List attendance periods

X

Create attendance period

X

Cost centers (Beta)

List cost centers

X

Custom reports

Get metadata about existing custom reports in your Personio account

X

Get data of an existing custom report

X

Get human-readable labels for report table columns

X

Document management

List document metadata

X

Update document metadata

X

Delete document

X

Download document

X

Documents

Fetch all document categories of the company

X

Employees

List company employees

X

Create an employee

X

Update an employee

X

Show employee by ID

X

Retrieve the absence balance for a specific employee

X

Get custom attributes

X

Lists all the allowed attributes per API credentials including custom (dynamic) attributes

X

Get employee profile picture

X

Employment

List employments of a given person

X

Update employment

X

Retrieve employment

X

Legal entities

List legal entities

X

Retrieve legal entity

X

Organization management: Org units

Retrieve org unit

X

Payroll integrations API: Compensations

List compensation types

X

List compensations

X

Create compensation

X

Create compensation types

X

Persons

List persons

X

Create person and employment

X

Retrieve a person

X

Update a person

X

Delete a person

X

Projects

Provides a list of all company projects

X

Creates a project into the company account

X

Deletes a project from the company account

X

Updates a project with the given data

X

Recruiting: Applications (Beta)

Get all applications

X

Get application by ID

X

Get all application stage transitions for application ID

X

Recruiting: Candidates (Beta)

List all candidates

X

Retrieve a candidate by ID

X

Recruiting: Categories (Beta)

List all job categories

X

Retrieve job category by ID

X

Recruiting: Jobs (Beta)

List all jobs

X

Retrieve job by ID

X

Webhooks management

List webhooks

X

Create new webhook

X

Get a webhook

X

Update a webhook

X

Delete a webhook

X

Get webhook delivery activity

X

Get webhook events

X

Redeliver webhook events

X

Send test event

X

Workplaces (Beta)

List all workplaces

X

API type: Recruiting

Resource

Endpoint

Import

Application

Create applications in Personio

X

Application documents

Upload application documents

X