Skip to main content
Personio logo
  • Category: human resources
  • Auth: S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 10
  • Triggers: 0
  • Slug: PERSONIO
  • Version: 00000000_00

Tools

Slug: PERSONIO_LIST_ABSENCE_PERIODSReturn v2 absence periods filtered by person, absence type, IDs, date-time bounds, or update time.

Input Parameters

integer
Maximum absence periods to return in this page (1-100).
string
Continuation cursor returned by the previous call; omit for the first page.
array
Person IDs to match.
array
Absence type IDs to match.
string
Return periods ending at or after this ISO 8601 date-time.
string
Return periods ending at or before this ISO 8601 date-time.
array
Absence period IDs to match.
string
Return periods starting at or after this ISO 8601 date-time.
string
Return periods starting at or before this ISO 8601 date-time.
string
Return periods updated at or after this ISO 8601 date-time.
string
Return periods updated at or before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_ABSENCE_TYPESReturn the v2 absence types configured for the company, including IDs, names, categories, and units.

Input Parameters

integer
Maximum absence types to return in this page (1-100).
string
Continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_ATTENDANCE_PERIODSReturn v2 attendance periods filtered by people, projects, status, attribution dates, time bounds, or update time.

Input Parameters

string
Comma-separated sort fields. Supported fields are person.id, start.date_time, end.date_time, updated_at, and status; prefix a field with ’-’ for descending order.
integer
Maximum attendance periods to return in this page (1-100).
string
Continuation cursor returned by the previous call; omit for the first page.
string ("PENDING" | "CONFIRMED" | "REJECTED")
Attendance approval status to match.
array
Person IDs to match.
array
Project IDs to match.
string
Return periods starting at or after this local date-time. Use YYYY-MM-DDTHH:MM:SS without Z or a timezone offset.
string
Return periods starting at or before this local date-time. Use YYYY-MM-DDTHH:MM:SS without Z or a timezone offset.
string
Return periods updated at or after this UTC date-time. Use an ISO 8601 value ending in Z; Personio also accepts a missing suffix as UTC.
string
Return periods updated at or before this UTC date-time. Use an ISO 8601 value ending in Z; Personio also accepts a missing suffix as UTC.
array
Attendance period IDs to match.
string
Return periods attributed on or after this date (YYYY-MM-DD).
string
Return periods attributed on or before this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_DOCUMENT_CATEGORIESReturn the legacy Personnel Data document categories and IDs used to classify or filter company documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_DOCUMENTSReturn v2 document metadata for one owner, optionally filtered by category and creation date; this does not download document contents.

Input Parameters

integer
Maximum document records to return in this page (1-200).
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
ID of the person or other owner whose document metadata should be listed.
string
Document category ID to match.
string
Return documents created before this date (YYYY-MM-DD), excluding the given date.
string
Return documents created on or after this date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_EMPLOYEE_ATTRIBUTESReturn the standard and custom employee attributes readable by the connected integration, including the keys accepted by list employee records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_EMPLOYEE_RECORDSReturn legacy Personnel Data employee records with selectable standard or custom attributes and incremental-update filtering; use List Persons for ordinary v2 identity lookup.

Input Parameters

string
Return the employee with this email address; ignored by Personio when updated_since is set.
integer
Maximum employee records to return in this page; ignored by Personio when updated_since is set.
integer
Continuation offset returned by the previous call; omit for the first page.
array
Employee attribute keys to return, including readable custom keys discovered with List Employee Attributes.
string
Return records updated after this ISO 8601 date-time or YYYY-MM-DD date. Personio ignores email, limit, and cursor when this filter is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_PERSON_EMPLOYMENTSReturn employment records for one v2 person, including status, type, and working-hours details.

Input Parameters

integer
Maximum employments to return in this page (1-50).
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Person ID whose employments should be returned.
string
Return employments updated after this ISO 8601 date-time.
array
Employment IDs to match.
string
Return employments updated before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_PERSONSReturn current v2 person summaries, optionally filtered by identity, status, or creation and update times; use employee records instead when custom Personnel Data attributes are needed.

Input Parameters

integer
Maximum persons to return in this page (1-50).
string
Continuation cursor returned by the previous call; omit for the first page.
array
Email addresses to match.
string ("ACTIVE" | "INACTIVE")
Employment-derived person status to match.
string
Last name to match.
string
First name to match.
array
Person IDs to match.
string
Return persons created after this ISO 8601 date-time.
string
Return persons updated after this ISO 8601 date-time.
string
Return persons created before this ISO 8601 date-time.
string
Preferred name to match.
string
Return persons updated before this ISO 8601 date-time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PERSONIO_LIST_PROJECTSReturn v2 time-tracking projects filtered by IDs, names, codes, status, hierarchy, or top-level membership.

Input Parameters

integer
Maximum projects to return in this page (1-200).
array
Project names to match.
string
Continuation cursor returned by the previous call; omit for the first page.
string ("ACTIVE" | "ARCHIVED")
Project status to match.
array
Additional project metrics to include in each result.
array
Project IDs to match.
array
Project codes to match.
boolean
When true, return only projects without a parent.
array
Parent project IDs to match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not