> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Personio

> Read Personio people, employment, attendance, absence, project, document, and employee-attribute data.

![Personio logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/personio.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=f1348d754a1639674e5676eb8b470546)

* **Category:** human resources
* **Auth:** S2S\_OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `PERSONIO`
* **Version:** 00000000\_00

## Tools

> [accordion] List Absence Periods
>
> **Slug:** `PERSONIO_LIST_ABSENCE_PERIODS`
>
> Return v2 absence periods filtered by person, absence type, IDs, date-time bounds, or update time.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum absence periods to return in this page (1-100).
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **person\_ids** `array`
>
> Person IDs to match.
>
> **absence\_type\_ids** `array`
>
> Absence type IDs to match.
>
> **ends\_at\_or\_after** `string`
>
> Return periods ending at or after this ISO 8601 date-time.
>
> **ends\_at\_or\_before** `string`
>
> Return periods ending at or before this ISO 8601 date-time.
>
> **absence\_period\_ids** `array`
>
> Absence period IDs to match.
>
> **starts\_at\_or\_after** `string`
>
> Return periods starting at or after this ISO 8601 date-time.
>
> **starts\_at\_or\_before** `string`
>
> Return periods starting at or before this ISO 8601 date-time.
>
> **updated\_at\_or\_after** `string`
>
> Return periods updated at or after this ISO 8601 date-time.
>
> **updated\_at\_or\_before** `string`
>
> Return periods updated at or before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Absence Types
>
> **Slug:** `PERSONIO_LIST_ABSENCE_TYPES`
>
> Return the v2 absence types configured for the company, including IDs, names, categories, and units.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum absence types to return in this page (1-100).
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attendance Periods
>
> **Slug:** `PERSONIO_LIST_ATTENDANCE_PERIODS`
>
> Return v2 attendance periods filtered by people, projects, status, attribution dates, time bounds, or update time.
>
> #### Input Parameters
>
> **sort** `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.
>
> **limit** `integer`
>
> Maximum attendance periods to return in this page (1-100).
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **status** `string ("PENDING" | "CONFIRMED" | "REJECTED")`
>
> Attendance approval status to match.
>
> **person\_ids** `array`
>
> Person IDs to match.
>
> **project\_ids** `array`
>
> Project IDs to match.
>
> **starts\_at\_or\_after** `string`
>
> Return periods starting at or after this local date-time. Use YYYY-MM-DDTHH:MM:SS without Z or a timezone offset.
>
> **starts\_at\_or\_before** `string`
>
> Return periods starting at or before this local date-time. Use YYYY-MM-DDTHH:MM:SS without Z or a timezone offset.
>
> **updated\_at\_or\_after** `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.
>
> **updated\_at\_or\_before** `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.
>
> **attendance\_period\_ids** `array`
>
> Attendance period IDs to match.
>
> **attributed\_on\_or\_after** `string`
>
> Return periods attributed on or after this date (YYYY-MM-DD).
>
> **attributed\_on\_or\_before** `string`
>
> Return periods attributed on or before this date (YYYY-MM-DD).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Document Categories
>
> **Slug:** `PERSONIO_LIST_DOCUMENT_CATEGORIES`
>
> Return the legacy Personnel Data document categories and IDs used to classify or filter company documents.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Documents
>
> **Slug:** `PERSONIO_LIST_DOCUMENTS`
>
> Return v2 document metadata for one owner, optionally filtered by category and creation date; this does not download document contents.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum document records to return in this page (1-200).
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **owner\_id** `string` *required*
>
> ID of the person or other owner whose document metadata should be listed.
>
> **category\_id** `string`
>
> Document category ID to match.
>
> **created\_before** `string`
>
> Return documents created before this date (YYYY-MM-DD), excluding the given date.
>
> **created\_on\_or\_after** `string`
>
> Return documents created on or after this date (YYYY-MM-DD).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Attributes
>
> **Slug:** `PERSONIO_LIST_EMPLOYEE_ATTRIBUTES`
>
> Return the standard and custom employee attributes readable by the connected integration, including the keys accepted by list employee records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Records
>
> **Slug:** `PERSONIO_LIST_EMPLOYEE_RECORDS`
>
> Return 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
>
> **email** `string`
>
> Return the employee with this email address; ignored by Personio when updated\_since is set.
>
> **limit** `integer`
>
> Maximum employee records to return in this page; ignored by Personio when updated\_since is set.
>
> **cursor** `integer`
>
> Continuation offset returned by the previous call; omit for the first page.
>
> **attributes** `array`
>
> Employee attribute keys to return, including readable custom keys discovered with List Employee Attributes.
>
> **updated\_since** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Person Employments
>
> **Slug:** `PERSONIO_LIST_PERSON_EMPLOYMENTS`
>
> Return employment records for one v2 person, including status, type, and working-hours details.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum employments to return in this page (1-50).
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **person\_id** `string` *required*
>
> Person ID whose employments should be returned.
>
> **updated\_after** `string`
>
> Return employments updated after this ISO 8601 date-time.
>
> **employment\_ids** `array`
>
> Employment IDs to match.
>
> **updated\_before** `string`
>
> Return employments updated before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Persons
>
> **Slug:** `PERSONIO_LIST_PERSONS`
>
> Return 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
>
> **limit** `integer`
>
> Maximum persons to return in this page (1-50).
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **emails** `array`
>
> Email addresses to match.
>
> **status** `string ("ACTIVE" | "INACTIVE")`
>
> Employment-derived person status to match.
>
> **last\_name** `string`
>
> Last name to match.
>
> **first\_name** `string`
>
> First name to match.
>
> **person\_ids** `array`
>
> Person IDs to match.
>
> **created\_after** `string`
>
> Return persons created after this ISO 8601 date-time.
>
> **updated\_after** `string`
>
> Return persons updated after this ISO 8601 date-time.
>
> **created\_before** `string`
>
> Return persons created before this ISO 8601 date-time.
>
> **preferred\_name** `string`
>
> Preferred name to match.
>
> **updated\_before** `string`
>
> Return persons updated before this ISO 8601 date-time.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Projects
>
> **Slug:** `PERSONIO_LIST_PROJECTS`
>
> Return v2 time-tracking projects filtered by IDs, names, codes, status, hierarchy, or top-level membership.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum projects to return in this page (1-200).
>
> **names** `array`
>
> Project names to match.
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **status** `string ("ACTIVE" | "ARCHIVED")`
>
> Project status to match.
>
> **include** `array`
>
> Additional project metrics to include in each result.
>
> **project\_ids** `array`
>
> Project IDs to match.
>
> **project\_codes** `array`
>
> Project codes to match.
>
> **top\_level\_only** `boolean`
>
> When true, return only projects without a parent.
>
> **parent\_project\_ids** `array`
>
> Parent project IDs to match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
