Personio
App · 27 actions
Manage people and projects, and read employments, absences, attendance and reports in Personio.
Actions
| Action | What it does |
|---|---|
| Add project members | Add project members. |
| Create person | Create person. |
| Create project | Create project. |
| Delete person | Delete person. |
| Delete project | Delete project. |
| Get absence period | Looks up one absence (a booking of time off) in Personio and returns who is away, the type of absence, its first and last day, any comment and whether it is approved. |
| Get absence type | Looks up one kind of time off in Personio and returns its name (such as Paid vacation), its category (such as PAID_VACATION or SICK_LEAVE) and whether it is booked in days or hours. |
| Get attendance period | Get attendance period. |
| Get employment | Get employment. |
| Get person | Get one person from Personio by their ID: their name, email, status, custom attributes and the IDs of their employments, under 'data'. |
| Get project | Get project. |
| Get report | Get report. |
| List absence breakdowns | List absence breakdowns. |
| List absence periods | Lists time off booked in Personio (vacation, sick leave and other absences), with who is away, the type of absence, its first and last day and whether it is approved. |
| List absence types | Lists the kinds of time off set up in Personio, such as Paid vacation and Sick leave, with each one's name, category (such as PAID_VACATION or SICK_LEAVE) and whether it is booked in days or hours. |
| List attendance periods | List attendance periods. |
| List contracts ending soon | List the active people whose contract ends within the next days you choose (60 unless you say otherwise), read from the contract end date of their employment in Personio. |
| List employments | List one person's employments in Personio, newest first (most people have one). |
| List people | Lists the people in Personio with each one's name, email address and whether they are active. |
| List people whose probation is ending | Find everyone whose probation period ends soon, with their manager. |
| List project members | List project members. |
| List projects | List projects. |
| List report attributes | List report attributes. |
| List reports | List reports. |
| Remove project members | Remove project members. |
| Update person | Update person. |
| Update project | Update project. |
Add project members
Add project members. Add Project Members
Inputs
- Project members
idtextRequired - Id.
- Person ids
person_idslistRequired - Person ids.
Outputs
dataobject- Response.
Example output
{
"data": {
"_data": []
}
}Create person
Create person. Create a new Person and Employment.
Inputs
- Email
emailtext - Email of the employee. The email must be unique : 2+ employees cannot have the same email.
- First name
first_nametextRequired - First name of the employee.
- Preferred name
preferred_nametext - The preferred name of the employee, if relevant.
- Last name
last_nametextRequired - Last name of the employee.
Outputs
dataobject- The response object when creating a Person and Employment.
Example output
{
"data": {
"_meta": {
"links": {
"self": "example"
}
},
"employments": [],
"id": "example"
}
}Create project
Create project. Create a project.
Inputs
- Name
nametextRequired - Name of the project.
- Status
statustextRequired - Status of the project.One of:
ACTIVE,ARCHIVED. - Project code
project_codetext - Optional project code. This field needs to be unique across all projects (regardless of top level or sub project). It can be used as a reference to the projects in another system.
- Description
descriptiontext - Optional project description.
- Assigned to all
assigned_to_alltrue/false - Flag to assign the project to all employees. Projects assigned to all employees can't have members. If set to true, every employee in the company is able to track time against this project. If set to false, only members of the project can track time against this project. If not provided, the default value is false. Sub projects (projects with a parent project) always have the same assigment as their parent project. This field shouldn't be provided for sub projects.
- Billable
billabletrue/false - Flag to mark project as billable. If not provided, the default value is false. Sub projects (projects with a parent project) always have the same billable flag as their parent project. This field shouldn't be provided for sub projects.
- Client name
client_nametext - Optional client name for the project. Sub projects (projects with a parent project) can't have a client name.
- Project type
project_typetext - Optional project type. This is a free text field defined by the customer. Sub projects (projects with a parent project) can't have a project type.
Outputs
dataobject- This is an object that is returned whenever a new resource is created. It contains the unique identifier for the created resource and optionally a link that can be used to retrieve it.
Example output
{
"data": {
"_meta": {
"links": {}
},
"id": "example"
}
}Delete person
Delete person. Delete a Person.
Inputs
- Person
person_idtextRequired - Person id.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Delete project
Delete project. Delete a Project.
Inputs
- Project
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Get absence period
Looks up one absence (a booking of time off) in Personio and returns who is away, the type of absence, its first and last day, any comment and whether it is approved.
Inputs
- Absence ID
idtextRequired - The absence's Personio ID, such as 2b7d6f04-9c1e-4a55-8d3b-6f0e1a2c3d4e. Use the id an absence trigger or List absence periods gave.
Outputs
dataobject- A period of time with an associated absence type.
Example output
{
"data": {
"absence_type": {
"id": "example"
},
"approval": {
"status": "PENDING"
},
"comment": "example",
"created_at": "example",
"ends_at": {
"date_time": "example",
"type": "FIRST_HALF"
},
"id": "example",
"person": {
"id": "example"
},
"starts_from": {
"date_time": "example",
"type": "FIRST_HALF"
},
"timezone_id": "example",
"updated_at": "example"
}
}Get absence type
Looks up one kind of time off in Personio and returns its name (such as Paid vacation), its category (such as PAID_VACATION or SICK_LEAVE) and whether it is booked in days or hours.
Inputs
- Absence type
idtextRequired - The absence type's Personio ID, such as abc6fa09-d8fe-4de0-be03-f0a1d48df766. Pick the type from the list, or use the absence type ID an absence gave.
Outputs
dataobject- AbsenceType represents a classification of absence periods.
Example output
{
"data": {
"category": "example",
"id": "example",
"name": "example",
"unit": "DAY"
}
}Get attendance period
Get attendance period. Get an attendance period.
Inputs
- Attendance period ID
idtextRequired - Id.
Outputs
dataobject- - Model of period entity. - Describes a period of work or break time associated with a person.
Example output
{
"data": {
"approval": {
"status": "PENDING"
},
"attribution_date": "example",
"comment": "example",
"created_at": "example",
"duration": "example",
"end": {
"date_time": "example"
},
"id": "example",
"is_auto_generated": false,
"legacy_break": 1,
"person": {
"id": "example"
},
"project": {
"id": "example"
},
"start": {
"date_time": "example"
},
"type": "WORK",
"updated_at": "example"
}
}Get employment
Get employment. Retrieve an employment.
Inputs
- Person
person_idtextRequired - Person id.
- Employment ID
idtextRequired - Id.
Outputs
dataobject- Employment schema
Example output
{
"data": {
"_meta": {
"links": {}
},
"contract_end_date": "example",
"cost_centers": [],
"created_at": "example",
"employment_end_date": "example",
"employment_start_date": "example",
"full_time_weekly_working_hours": 1.0,
"id": "example",
"job": {
"id": "example"
},
"legal_entity": {
"id": "example"
},
"office": {
"id": "example"
},
"org_units": [],
"person": {
"id": "example"
},
"position": {
"title": "example"
},
"probation_end_date": "example",
"status": "ACTIVE",
"sub_company": {
"id": "example"
},
"supervisor": {
"id": "example"
},
"termination": {
"last_working_day": "example",
"reason": "example",
"terminated_at": "example",
"termination_date": "example",
"type": "UNSPECIFIED"
},
"type": "UNSPECIFIED",
"updated_at": "example",
"weekly_working_hours": 1.0
}
}Get person
Get one person from Personio by their ID: their name, email, status, custom attributes and the IDs of their employments, under 'data'. Their job title, manager, start date and probation end date are on their employment (see 'List employments'). A field Personio has no value for is empty (null) or left out.
Inputs
- Person
idtextRequired - The person's Personio ID, a number such as 12345678. Pick the person from the list, or use the id a trigger or an earlier Personio step gave.
Outputs
dataobject- Person schema example
Example output
{
"data": {
"_meta": {
"links": {}
},
"created_at": "example",
"custom_attributes": [],
"email": "example",
"employments": [],
"first_name": "example",
"gender": "UNSPECIFIED",
"id": "example",
"last_name": "example",
"preferred_name": "example",
"profile_picture": {
"url": "example"
},
"status": "UNSPECIFIED",
"updated_at": "example"
}
}Get project
Get project. Get a Project.
Inputs
- Project
idtextRequired - Id.
- Include
includelist - Include.One or more of:
tracked_minutes(Tracked minutes),sub_projects_tracked_minutes(Sub projects tracked minutes),sub_projects_count(Sub projects count),tracked_periods_count(Tracked periods count).
Outputs
dataobject- - Model of project entity. - Describes a project that can be associated with an attendance period.
Example output
{
"data": {
"assigned_to_all": false,
"billable": false,
"client_name": "example",
"cost_center": {
"id": "example"
},
"created_at": "example",
"description": "example",
"end": {
"date": "example"
},
"id": "example",
"name": "example",
"parent_project": {
"id": "example"
},
"project_code": "example",
"project_type": "example",
"start": {
"date": "example"
},
"status": "ACTIVE",
"sub_projects_count": 1,
"sub_projects_tracked_minutes": 1,
"tracked_minutes": 1,
"tracked_periods_count": 1,
"updated_at": "example"
}
}Get report
Get report. Retrieves a report.
Inputs
- Report ID
idtextRequired - Id.
- Locale
localetext - The locale/language setting used for the current user.Default:
en. - Cursor
cursortext - Cursor.
- Page size
limitnumber - Limit.From 1 to 100. Default:
100.
Outputs
dataobject- The response object for retrieving a specific report, including configuration and data.
Example output
{
"data": {
"_data": [],
"_meta": {
"columns": [],
"links": {
"next": "example",
"self": "example"
}
},
"report_config": {
"config": {
"column_calculation": "none",
"columns": [],
"filter_group": {
"filters": [],
"operator": "and"
},
"group_bys": [],
"row_calculation": "none",
"sort_bys": [],
"timerange": {
"date_field": "example",
"date_range": {
"from": "example",
"to": "example"
},
"date_range_option": "custom",
"group_by": "days"
},
"title": "example",
"visualization_type": "treemap"
},
"description": "example",
"historical_report": {
"attributes": [],
"filter_group": {
"filters": [],
"operator": "and"
},
"group_bys": [],
"people_identifiers": [],
"show_effective_date_column": false,
"sort_bys": [],
"time_frame_config": {
"date_field": "example",
"date_range": {
"from": "example",
"to": "example"
},
"date_range_option": "custom",
"group_by": "days"
}
},
"name": "example",
"title": "example"
}
}
}List absence breakdowns
List absence breakdowns. Retrieves daily absence period breakdowns for a given absence period.
Inputs
- Absence breakdowns ID
idtextRequired - Id.
- Cursor
cursortext - Cursor.
- Page size
limitnumber - Limit.From 1 to 28. Default:
28.
Outputs
dataobject- A daily breakdown of an absence period indicating how much absence balance is consumed for each day of the absence period. There will be one entry for each day in the absence period, ordered chronologically. If an absence period is ongoing (it has `ends_at = null`), breakdowns will exist for every completed day up to the current day.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
}
}List absence periods
Lists time off booked in Personio (vacation, sick leave and other absences), with who is away, the type of absence, its first and last day and whether it is approved. Narrow the list by person, absence type or dates. Each absence names its person and absence type by ID; use Get person and Get absence type to read their names. Returns up to 100 at a time.
Inputs
- Page size
limitnumber - How many absences to return at once, from 1 to 100. Leave blank for 100.From 1 to 100. Default:
100. - Cursor
cursortext - Leave blank to start at the beginning of the list. To carry on a long list, enter the cursor from the previous page: the text after cursor= in data._meta.links.next.href.
- Absence ID
idtext - Only the absence with this Personio ID, such as 2b7d6f04-9c1e-4a55-8d3b-6f0e1a2c3d4e. Leave blank for all absences.
- Absence type
absence_type_idtext - Only absences of this type, such as Paid vacation. Pick the type from the list, or use an absence type ID from an earlier step.
- Person
person_idtext - Only this person's absences. Pick the person from the list, or use a person ID such as 12345678 from a trigger or an earlier step.
- Starts on or after
starts_from_date_time_gtedate and time - Only absences that start at or after this date and time. Enter the date and time in UTC.
- Starts on or before
starts_from_date_time_ltedate and time - Only absences that start at or before this date and time. Enter the date and time in UTC.
- Ends on or before
ends_at_date_time_ltedate and time - Only absences that end at or before this date and time. Enter the date and time in UTC.
- Ends on or after
ends_at_date_time_gtedate and time - Only absences that end at or after this date and time. Use it with Starts on or before to find who is away in a period. Enter the date and time in UTC.
- Changed on or after
updated_at_gtedate and time - Only absences booked or changed at or after this date and time.
- Changed on or before
updated_at_ltedate and time - Only absences booked or changed at or before this date and time.
Outputs
dataobject- Response.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
}
}List absence types
Lists the kinds of time off set up in Personio, such as Paid vacation and Sick leave, with each one's name, category (such as PAID_VACATION or SICK_LEAVE) and whether it is booked in days or hours.
Inputs
- Cursor
cursortext - Leave blank to start at the beginning of the list. To carry on a long list, enter the cursor from the previous page: the text after cursor= in data._meta.links.next.href.
- Page size
limitnumber - How many absence types to return at once, from 1 to 100. Leave blank for 100.From 1 to 100. Default:
100.
Outputs
dataobject- A list of all defined absence types.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
}
}List attendance periods
List attendance periods. List attendance periods.
Inputs
- Cursor
cursortext - Cursor.
- Page size
limitnumber - Limit.From 1 to 100. Default:
100. - Attendance periods ID
idlist - Id.
- Person
person_idlist - Person id.
- Start time on or after
start_date_time_gtedate and time - An RFC3339 date and timestamp without a timezone offset. Enter the date and time in UTC.
- Start time on or before
start_date_time_ltedate and time - An RFC3339 date and timestamp without a timezone offset. Enter the date and time in UTC.
- End time on or before
end_date_time_ltedate and time - An RFC3339 date and timestamp without a timezone offset. Enter the date and time in UTC.
- End time on or after
end_date_time_gtedate and time - An RFC3339 date and timestamp without a timezone offset. Enter the date and time in UTC.
- Updated on or after
updated_at_gtedate and time - An RFC3339 date and timestamp representing an instant in UTC. A trailing `Z` is accepted (but optional for backwards compatibility reasons, UTC is still assumed then); no other timezone offset is supported.
- Updated on or before
updated_at_ltedate and time - An RFC3339 date and timestamp representing an instant in UTC. A trailing `Z` is accepted (but optional for backwards compatibility reasons, UTC is still assumed then); no other timezone offset is supported.
- Work date on or after
attribution_date_gtedate - Attribution date gte.
- Work date on or before
attribution_date_ltedate - Attribution date lte.
- Project
project_idlist - Project id.
- Status
statustext - Status.One of:
PENDING,CONFIRMED,REJECTED. - Sort
sortlist - Fields to sort by, in priority order. A minus sign reverses the order.One or more of:
person.id,-person.id,start.date_time(Start.date time),-start.date_time(-start.date time),end.date_time(End.date time),-end.date_time(-end.date time),updated_at(Updated at),-updated_at(-updated at),status,-status.
Outputs
dataobject- Response.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
}
}List contracts ending soon
List the active people whose contract ends within the next days you choose (60 unless you say otherwise), read from the contract end date of their employment in Personio. Each person comes with their name, email, department, job title, contract end date, days left, and their manager's name and email, sorted by department and then by date. The same list also comes grouped by department and as one text ready to email, so a reminder needs no lookup, filter or grouping step. 'count' is 0 when nobody's contract is ending.
Inputs
- Days ahead
daysnumber - How far ahead to look: people whose contract ends today or within this many days are listed.From 1 to 365. Default:
60. - Include people who are leaving
include_terminationstrue/false - Also list people whose termination date in Personio falls within the same days (someone who resigned or was let go), not only those whose contract runs out.Default:
false.
Outputs
by_departmentlist- The same people grouped by department, in alphabetical order, so a message with a section per department needs no grouping step.
countnumber- How many people are listed. 0 when nobody's contract is ending, so check this before sending anything.
daysnumber- How many days ahead were checked.
from_datetext- Today's date (UTC), the first day checked, as YYYY-MM-DD.
peoplelist- The people whose contract is ending, sorted by department and then by date, soonest first.
people_checkednumber- How many active people in Personio were looked at.
texttext- The whole list as text ready to email as it is: a section per department, headed with its name and how many people, then one line per person with their name, job title, end date and manager. Empty when nobody is listed, so check 'count' first.
to_datetext- The last day checked, as YYYY-MM-DD.
to_date_displaytext- The last day checked ready to read, such as Jan 11, 2027.
Example output
{
"by_department": [
{
"count": 1,
"department": "Sales",
"people": [
{
"days_left": 49,
"email": "ada@example.com",
"end_date": "2026-12-31",
"end_date_display": "Dec 31, 2026",
"job_title": "Account Manager",
"manager_email": "grace@example.com",
"manager_name": "Grace Hopper",
"name": "Ada Lovelace"
}
],
"people_text": "\u2022 Ada Lovelace, Account Manager: contract ends Dec 31, 2026 (in 49 days). Manager: Grace Hopper (grace@example.com)"
}
],
"count": 1,
"days": 60,
"from_date": "2026-11-12",
"people": [
{
"contract_end_date": "2026-12-31",
"contract_end_date_display": "Dec 31, 2026",
"days_left": 49,
"department": "Sales",
"department_id": "231",
"email": "ada@example.com",
"employment_id": "9001",
"end_date": "2026-12-31",
"end_date_display": "Dec 31, 2026",
"end_reason": "Contract ends",
"first_name": "Ada",
"job_title": "Account Manager",
"last_name": "Lovelace",
"manager_email": "grace@example.com",
"manager_id": "4223",
"manager_name": "Grace Hopper",
"name": "Ada Lovelace",
"person_id": "3003",
"termination_date": null,
"termination_date_display": ""
}
],
"people_checked": 120,
"text": "Sales (1 person)\n\u2022 Ada Lovelace, Account Manager: contract ends Dec 31, 2026 (in 49 days). Manager: Grace Hopper (grace@example.com)",
"to_date": "2027-01-11",
"to_date_display": "Jan 11, 2027"
}List employments
List one person's employments in Personio, newest first (most people have one). Each employment has the job title (position.title), status, start date, probation end date, contract end date, office and department IDs, and the manager as 'supervisor.id': the manager's person ID only, so use 'Get person' for their name and email. Results are under 'data._data'. Personio has no list of everyone's employments, so this takes one person at a time; to find whose probation is ending, use 'List people whose probation is ending' instead. For more than one page, pass 'next_cursor' from this step's result as Cursor on the next call; it is blank when there are no more pages. A date Personio has no value for is empty (null) or left out.
Inputs
- Person
person_idtextRequired - The person whose employments to list: pick one, or use a person's ID from an earlier step.
- Page size
limitnumber - How many to return in one page, from 1 to 50.From 1 to 50. Default:
50. - Cursor
cursortext - Leave blank for the first page. For the next page, put the 'next_cursor' this step returned for the page before. 'next_cursor' is blank on the last page.
- Employments ID
idtext - Only the employments with these IDs. For several, separate them with commas.
- Updated at
updated_atdate and time - Only employments last changed at exactly this date and time.
- Updated after
updated_at_gtdate and time - Only employments changed after this date and time.
- Updated before
updated_at_ltdate and time - Only employments changed before this date and time.
Outputs
dataobject- Response.
next_cursortext- The cursor of the next page: put it in this step's Cursor field to get the page after this one. Blank when this is the last page.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
},
"next_cursor": ""
}List people
Lists the people in Personio with each one's name, email address and whether they are active. Narrow the list by name, email, status or when they were added or changed. Returns up to 50 at a time.
Inputs
- Page size
limitnumber - How many people to return at once, from 1 to 50. Leave blank for 50.From 1 to 50. Default:
50. - Cursor
cursortext - Leave blank for the first page. For the next page, put the 'next_cursor' this step returned for the page before. 'next_cursor' is blank on the last page.
- Person ID
idtext - Only the person with this Personio ID, a number such as 12345678. Leave blank for everyone.
- Email
emailtext - Only the person with this email address, such as jane@example.com.
- First name
first_nametext - Only people with this first name, such as Jane.
- Last name
last_nametext - Only people with this last name, such as Doe.
- Preferred name
preferred_nametext - Only people who go by this name in Personio, such as Janie.
- Added at
created_atdate and time - Only people added to Personio at exactly this date and time. To cover a period, use Added after and Added before instead.
- Added after
created_at_gtdate and time - Only people added to Personio after this date and time.
- Added before
created_at_ltdate and time - Only people added to Personio before this date and time.
- Changed at
updated_atdate and time - Only people whose details last changed at exactly this date and time. To cover a period, use Changed after and Changed before instead.
- Changed after
updated_at_gtdate and time - Only people whose details changed after this date and time.
- Changed before
updated_at_ltdate and time - Only people whose details changed before this date and time.
- Status
statustext - Only active people, or only inactive ones (people who have left or not started). Leave blank for both.One of:
ACTIVE,INACTIVE.
Outputs
dataobject- Response.
next_cursortext- The cursor of the next page: put it in this step's Cursor field to get the page after this one. Blank when this is the last page.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
},
"next_cursor": ""
}List people whose probation is ending
Find everyone whose probation period ends soon, with their manager. Returns each active person whose probation ends today or within the number of days you choose (14 unless you say otherwise), with their name, email, job title, department, start date, the day probation ends, how many days are left, and their manager's name and email. The same people come grouped by manager, each group with the manager's email and a ready-made text list and HTML table of their people, so emailing each manager their own list is this step, a loop over 'by_manager' and a send: no filtering, grouping or lookup steps. People with no manager, or whose manager has no email in Personio, are listed separately in 'without_manager_email'. The step reads every page itself. Personio only gives probation dates one person at a time, so it reads each active person's employment record, which can take a minute or more on an account with many hundreds of people. 'Today' is the date in UTC. The connection needs Read access to Employees in Personio, with the probation end date, supervisor and position shared.
Inputs
- Within the next (days)
within_daysnumber - How many days ahead to look. 14 finds probation ending today or in the next 14 days; 0 finds only today. Leave blank for 14. People whose probation has already ended are never listed.From 0 to 366. Default:
14.
Outputs
by_managerlist- The same people grouped by manager, one entry per manager who has an email address, in order of the manager's name. Loop over this list to send each manager one email. People with no manager, or whose manager has no email, are not here: they are in 'without_manager_email'. Empty when there is nobody.
countnumber- How many people are listed. 0 when there is nobody, so 'do nothing when the list is empty' is one check.
peoplelist- Everyone whose probation ends in the chosen days, soonest first. Empty when there is nobody.
people_checkednumber- How many active people in Personio the step looked at to build the list.
texttext- The whole list as plain text: each manager's name and count, then one line per person, with the people who have no manager email last. Ready to post as one message. Blank when there is nobody.
to_datetext- The last day the step looked at, a date such as 2026-11-26.
to_date_displaytext- The last day the step looked at, ready to read, such as Nov 26, 2026.
within_daysnumber- How many days ahead the step looked.
without_manager_emaillist- The people who are in no manager's group because they have no manager in Personio, or their manager has no email there. Send these to HR instead. Empty when everyone has a manager with an email.
without_manager_email_countnumber- How many people are in 'without_manager_email'. 0 when there are none.
without_manager_email_texttext- The people in 'without_manager_email' as plain text, one line each. Blank when there are none.
Example output
{
"by_manager": [
{
"count": 1,
"manager_email": "jen.doe@example.com",
"manager_id": "3003",
"manager_name": "Jen Doe",
"people": [
{
"days_left": 8,
"department": "Platform",
"email": "ana.silva@example.com",
"first_name": "Ana",
"full_name": "Ana Silva",
"id": "5005",
"job_title": "Software Engineer",
"last_name": "Silva",
"manager_email": "jen.doe@example.com",
"manager_id": "3003",
"manager_name": "Jen Doe",
"probation_end_date": "2026-11-20",
"probation_end_date_display": "Nov 20, 2026",
"start_date": "2026-05-20",
"start_date_display": "May 20, 2026"
}
],
"people_html": "<table border=\"1\" cellpadding=\"6\" cellspacing=\"0\"><tr><th>Name</th><th>Job title</th><th>Department</th><th>Probation ends</th><th>Time left</th></tr><tr><td>Ana Silva</td><td>Software Engineer</td><td>Platform</td><td>Nov 20, 2026</td><td>in 8 days</td></tr></table>",
"people_text": "\u2022 Ana Silva (Software Engineer, Platform): probation ends Nov 20, 2026 (in 8 days)"
}
],
"count": 1,
"people": [
{
"days_left": 8,
"department": "Platform",
"email": "ana.silva@example.com",
"first_name": "Ana",
"full_name": "Ana Silva",
"id": "5005",
"job_title": "Software Engineer",
"last_name": "Silva",
"manager_email": "jen.doe@example.com",
"manager_id": "3003",
"manager_name": "Jen Doe",
"probation_end_date": "2026-11-20",
"probation_end_date_display": "Nov 20, 2026",
"start_date": "2026-05-20",
"start_date_display": "May 20, 2026"
}
],
"people_checked": 42,
"text": "Jen Doe (1 person)\n\u2022 Ana Silva (Software Engineer, Platform): probation ends Nov 20, 2026 (in 8 days)",
"to_date": "2026-11-26",
"to_date_display": "Nov 26, 2026",
"within_days": 14,
"without_manager_email": [],
"without_manager_email_count": 0,
"without_manager_email_text": ""
}List project members
List project members. List Project Members
Inputs
- Project members
idtextRequired - Id.
- Cursor
cursortext - Cursor.
- Page size
limitnumber - Limit.From 1 to 200. Default:
100.
Outputs
dataobject- Response.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
}
}List projects
List projects. List Projects
Inputs
- Cursor
cursortext - Cursor.
- Page size
limitnumber - Limit.From 1 to 200. Default:
100. - Projects ID
idlist - Id.
- Name
namelist - Name.
- Status
statustext - Status.One of:
ACTIVE,ARCHIVED. - Project code
project_codelist - Project code.
- Parent project ID
parent_project_idlist - Parent project id.
- Top level only
top_level_onlytrue/false - Top level only.
- Include
includelist - Include.One or more of:
tracked_minutes(Tracked minutes),sub_projects_tracked_minutes(Sub projects tracked minutes),sub_projects_count(Sub projects count),tracked_periods_count(Tracked periods count).
Outputs
dataobject- Response.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {}
}
}
}List report attributes
List report attributes. Lists all report attributes for a company.
Inputs
- Locale
localetext - The locale/language setting used for the current user.Default:
en.
Outputs
dataobject- The API response object containing a list of available report attributes that can be used in report creation, along with associated metadata such as attribute domains.
Example output
{
"data": {
"_data": []
}
}List reports
List reports. Lists all reports for a company.
Inputs
- Name
nametext - Name.
- Cursor
cursortext - Cursor.
- Page size
limitnumber - Limit.From 1 to 100. Default:
100.
Outputs
dataobject- Represents the API response containing an array of report objects and related metadata, such as pagination details.
Example output
{
"data": {
"_data": [],
"_meta": {
"links": {
"next": "example",
"self": "example"
}
}
}
}Remove project members
Remove project members. Remove Project Members
Inputs
- Project members
idtextRequired - Id.
- People to remove
person_idlistRequired - Person id.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Update person
Update person. Update a Person.
Inputs
- Person
person_idtextRequired - Person id.
- Email
emailtext - Email of the employee. The email must be unique : 2+ employees cannot have the same email.
- First name
first_nametext - First name of the employee.
- Preferred name
preferred_nametext - The preferred name of the employee, if relevant.
- Last name
last_nametext - Last name of the employee.
Outputs
dataobject- Response.
Example output
{
"data": {}
}Update project
Update project. Update a Project.
Inputs
- Project
idtextRequired - Id.
- Name
nametext - Name of the project.
- Status
statustext - Status of the project.One of:
ACTIVE,ARCHIVED. - Project code
project_codetext - Optional project code. This field needs to be unique across all projects (regardless of top level or sub project). It can be used as a reference to the projects in another system.
- Description
descriptiontext - Optional project description.
- Assigned to all
assigned_to_alltrue/false - Flag to assign the project to all employees. Projects assigned to all employees can't have members. If set to true, every employee in the company is able to track time against this project. If set to false, only members of the project can track time against this project. When this field is updated from false to true, all the project's existing members are removed. Sub projects (projects with a parent project) always have the same assigment as their parent project. This field shouldn't be provide
- Billable
billabletrue/false - Flag to mark project as billable. Sub projects (projects with a parent project) always have the same billable flag as their parent project. This field shouldn't be provided for sub projects.
- Client name
client_nametext - Optional client name for the project. Sub projects (projects with a parent project) can't have a client name.
- Project type
project_typetext - Optional project type. This is a free text field defined by the customer. Sub projects (projects with a parent project) can't have a project type.
Outputs
dataobject- Response.
Example output
{
"data": {}
}