Factorial
App · 20 actions
Read employees, recruiting, attendance, documents, teams, locations, legal entities and leave.
Actions
| Action | What it does |
|---|---|
| Get candidate | Get candidate in the connected company. |
| Get document | Get document in the connected company. |
| Get employee | Get employee in the connected company. |
| Get job posting | Get job posting in the connected company. |
| Get leave | Get leave in the connected company. |
| Get leave type | Get leave type in the connected company. |
| Get legal entity | Read a legal entity in the connected company. |
| Get location | Get location in the connected company. |
| Get shift | Get shift in the connected company. |
| Get team | Get team in the connected company. |
| List candidates | List candidates in the connected company. |
| List documents | List documents in the connected company. |
| List employees | List employees in the connected company. |
| List job postings | List job postings in the connected company. |
| List leave types | List leave types in the connected company. |
| List leaves | List leaves in the connected company. |
| List legal entities | List legal entities in the connected company. |
| List locations | List locations in the connected company. |
| List shifts | List shifts in the connected company. |
| List teams | List teams in the connected company. |
Get candidate
Get candidate in the connected company.
Inputs
- Candidate
candidate_idtextRequired - list of candidate identifiers.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"ats_job_posting_ids": [],
"company_id": "example",
"consent_expiration_date": "example",
"consent_given_at": "example",
"consent_to_talent_pool": false,
"created_at": "example",
"email": "example",
"first_name": "example",
"full_name": "example",
"gender": "female",
"id": "example",
"inactive_since": "example",
"last_name": "example",
"medium": "example",
"personal_url": "example",
"phone_number": "example",
"score": 0,
"source_id": "example",
"talent_pool": false,
"updated_at": "example"
},
"has_more": false,
"next_cursor": null
}Get document
Get document in the connected company.
Inputs
- Document
document_idtextRequired - list of document identifiers.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"author_id": "example",
"company_id": "example",
"content_type": "example",
"created_at": "example",
"deleted_at": "example",
"employee_id": "example",
"extension": "example",
"file_size": 0,
"filename": "example",
"folder_id": "example",
"id": "example",
"is_company_document": false,
"is_management_document": false,
"is_pending_assignment": false,
"leave_id": "example",
"public": false,
"signature_status": "pending",
"signees": [],
"space": "example",
"updated_at": "example"
},
"has_more": false,
"next_cursor": null
}Get employee
Get employee in the connected company.
Inputs
- Employee
employee_idtextRequired - Return only the employees with these ids. Ids outside what the reader may see are dropped, rather than failing the whole read.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"access_id": "example",
"active": false,
"address_line_1": "example",
"address_line_2": "example",
"age_number": 0,
"attendable": false,
"bank_number": "example",
"bank_number_format": "iban",
"birth_name": "example",
"birthday_on": "example",
"birthplace": "example",
"city": "example",
"communications_email": "example",
"company_id": "example",
"company_identifier": "example",
"contact_name": "example",
"contact_number": "example",
"country": "example",
"country_of_birth": "example",
"created_at": "example",
"default_work_area_id": "example",
"disability_percentage_cents": 0,
"email": "example",
"first_name": "example",
"full_name": "example",
"gender": "example",
"id": "example",
"identifier": "example",
"identifier_expiration_date": "example",
"identifier_type": "example",
"is_terminating": false,
"last_name": "example",
"legal_entity_id": "example",
"location_id": "example",
"login_email": "example",
"manager_id": "example",
"nationality": "example",
"personal_email": "example",
"phone_number": "example",
"postal_code": "example",
"preferred_name": "example",
"pronouns": "example",
"seniority_calculation_date": "example",
"social_security_number": "example",
"state": "example",
"swift_bic": "example",
"terminated_on": "example",
"termination_observations": "example",
"termination_reason": "example",
"termination_reason_type": "example",
"termination_type_description": "example",
"timeoff_manager_id": "example",
"unconfirmed_communications_email": "example",
"updated_at": "example"
},
"has_more": false,
"next_cursor": null
}Get job posting
Get job posting in the connected company.
Inputs
- Job posting
job_posting_idtextRequired - Api id to use.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"ats_company_id": "example",
"category": "administration_and_secretariat",
"company_id": "example",
"contract_type": "indefinite",
"cover_letter_requirement": "mandatory",
"created_at": "example",
"cv_requirement": "mandatory",
"description": "example",
"hide_salary": false,
"id": "example",
"legal_entity_id": "example",
"location_id": "example",
"personal_url_requirement": "mandatory",
"phone_requirement": "mandatory",
"photo_requirement": "mandatory",
"published_at": "example",
"remote": false,
"salary_format": "fixed_amount",
"salary_from_amount_in_cents": 0,
"salary_period": "annual",
"salary_to_amount_in_cents": 0,
"schedule_type": "full_time",
"status": "draft",
"team_id": "example",
"title": "example",
"url": "example",
"workplace_type": "onsite"
},
"has_more": false,
"next_cursor": null
}Get leave
Get leave in the connected company.
Inputs
- Leave
leave_idtextRequired - Return only the leaves with these ids.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"approved": false,
"company_id": "example",
"created_at": "example",
"days_taken": 0,
"deleted_at": "example",
"description": "example",
"duration_attributes": "example",
"duration_by_day_attributes": {
"used_units_by_day": {
"days": "example",
"hours": "example"
},
"workable_units_by_day": {
"days": "example",
"hours": "example"
}
},
"employee_full_name": "example",
"employee_id": "example",
"finish_on": "example",
"half_day": "example",
"hours_amount_in_cents": 0,
"id": "example",
"leave_type_id": "example",
"leave_type_name": "example",
"reason": "example",
"start_on": "example",
"start_time": "example",
"updated_at": "example"
},
"has_more": false,
"next_cursor": null
}Get leave type
Get leave type in the connected company.
Inputs
- Leave type
leave_type_idtextRequired - Return only the leave types with these ids.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"accrues": false,
"active": false,
"allow_endless": false,
"allowance_ids": [],
"approval_required": false,
"attachment": false,
"color": "example",
"company_id": "example",
"description": "example",
"details_required": false,
"editable": false,
"half_days_units_enabled": false,
"id": "example",
"identifier": "example",
"is_attachment_mandatory": false,
"max_days_in_cents": 0,
"min_days_in_cents": 0,
"name": "example",
"payable": false,
"restricted": false,
"translated_name": "example",
"visibility": false,
"workable": false
},
"has_more": false,
"next_cursor": null
}Get legal entity
Read a legal entity in the connected company.
Inputs
- Legal entity
legal_entity_idtextRequired - Return only the legal entities with these ids.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"company_id": "example",
"country": "example",
"currency": "example",
"id": "example",
"legal_name": "example",
"postal_code": "example",
"siret": "example",
"state": "example",
"tin": "example"
},
"has_more": false,
"next_cursor": null
}Get location
Get location in the connected company.
Inputs
- Location
location_idtextRequired - The location IDs to filter the results.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"address_line_1": "example",
"address_line_2": "example",
"city": "example",
"company_id": "example",
"country": "example",
"id": "example",
"latitude": 0,
"longitude": 0,
"main": false,
"name": "example",
"phone_number": "example",
"postal_code": "example",
"radius": 0,
"siret": "example",
"state": "example",
"timezone": "example"
},
"has_more": false,
"next_cursor": null
}Get shift
Get shift in the connected company.
Inputs
- Shift
shift_idtextRequired - Return only the shifts with these ids.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"clock_in": "example",
"clock_in_with_seconds": "example",
"clock_out": "example",
"company_id": "example",
"created_at": "example",
"date": "example",
"employee_id": "example",
"half_day": "beginning_of_day",
"id": "example",
"in_location_accuracy": 0,
"in_location_latitude": 0,
"in_location_longitude": 0,
"in_source": "example",
"location_type": "office",
"minutes": 0,
"observations": "example",
"out_location_accuracy": 0,
"out_location_latitude": 0,
"out_location_longitude": 0,
"out_source": "example",
"reference_date": "example",
"time_settings_break_configuration_id": "example",
"updated_at": "example",
"workable": false,
"workplace_id": "example"
},
"has_more": false,
"next_cursor": null
}Get team
Get team in the connected company.
Inputs
- Team
factorial_team_idtextRequired - Return only the teams with these ids.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"avatar": "example",
"company_id": "example",
"depth": 0,
"description": "example",
"employee_ids": [],
"id": "example",
"lead_ids": [],
"name": "example",
"parent_team_id": "example"
},
"has_more": false,
"next_cursor": null
}List candidates
List candidates in the connected company.
Inputs
- Ids
idslist - list of candidate identifiers.
- Emails
emailslist - list of candidate emails.
- Team ids
team_idslist - list of team identifiers, refers to teams/teams endpoint.
- Location ids
location_idslist - list of location identifiers, refers to locations/locations endpoint.
- Source
sourcelist - source of the candidate.
- Remote
remotetrue/false - is the candidate remote?
- Job posting ids
job_posting_idslist - list of job posting identifiers, refers to ats/job_postings endpoint.
- Minimum average rating
minimum_average_ratingnumber - minimum average rating of the candidate.
- Active
activetrue/false - is the candidate active?
- Talent pool
talent_pooltrue/false - is the candidate part of talent pool?
- Archived
archivedtrue/false - is the candidate archived?
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List documents
List documents in the connected company.
Inputs
- By bookkeeper documents
by_bookkeeper_documentstrue/false - flag to indicate if the document belongs to a bookkeeper.
- By pending assignment
by_pending_assignmenttrue/false - flag to indicate if the document is pending assignment.
- By trash bin
by_trash_bintrue/false - flag to indicate if the document is in the trash bin.
- By without folder
by_without_foldertrue/false - flag to indicate if the document doesn't have a folder.
- Employee ids
employee_idslist - list of employee identifiers.
- Folder id
folder_idtext - folder identifier.
- Ids
idslist - list of document identifiers.
- Leave id
leave_idtext - leave identifier associated to the document, refers to /timeoff/leaves endpoint.
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List employees
List employees in the connected company.
Inputs
- Ids
idslist - Return only the employees with these ids. Ids outside what the reader may see are dropped, rather than failing the whole read.
- Access ids
access_idslist - filter by employee access ids.
- Emails
emailslist - filter by employee emails.
- Full text name
full_text_nametext - filter by employee name.
- Updated on or after
updated_at_gteqdate - Filter employees by their latest update timestamp (`updated_at`), on or after this date. Only the date is considered; any time component is ignored (matching starts at 00:00:00 of the given date). Note: `updated_at` only stores the most recent update, so an employee updated multiple times is matched solely by its latest update, not by earlier ones.
- Legal entity ids
legal_entity_idslist - Return only the employees whose contract is under these legal entities.
- Company identifier
company_identifiertext - filter by employee company identifier.
- Only active
only_activetrue/false - Set to true to keep only the employees not terminated as of today: those with no termination date, or one still in the future. Passing false has no effect, and it is ignored altogether when `include_active_and_terminated` is set.
- Team ids
team_idslist - Return only the employees who belong to these teams.
- Location ids
location_idslist - Return only the employees whose default workplace is one of these locations.
- Only managers
only_managerstrue/false - Set to true to return only the employees who have at least one direct report. Passing false has no effect.
- Name starts with
name_starts_withtext - filter by employee names that start with the given text.
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List job postings
List job postings in the connected company.
Inputs
- Ids
idslist - Ids to use.
- Status
statustext - Status to use.One of:
draft,published,unlisted,archived,cancelled,deleted. - Record team id
record_team_idtext - Record team id to use.
- Location id
location_idtext - Location id to use.
- Legal entity id
legal_entity_idtext - Legal entity id to use.
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List leave types
List leave types in the connected company.
Inputs
- Ids
idslist - Return only the leave types with these ids.
- Company ids
company_idslist - Return only the leave types of these companies.
- Active
activetrue/false - Set to true for the leave types currently in use, false for the retired ones. Leave it unset to get both.
- Payable
payabletrue/false - Set to true for the leave types that are paid, false for the unpaid ones. Leave it unset to get both.
- Identifier
identifiertext - A unique identifier for the leave type, or an array of identifiers
- Employee id
employee_idtext - Return only the leave types the time-off policy in force for this employee grants. It REQUIRES `reference_date`, which says on which date to resolve that policy: without it the read raises.
- Reference date
reference_datetext - The date on which to resolve the employee's time-off policy. Only meaningful alongside `employee_id`, and mandatory whenever that is given.
- Leave type
leave_type_idtext - Identifier of a specific leave type
- Allow endless
allow_endlesstrue/false - Whether the leave type allows for no end date
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List leaves
List leaves in the connected company.
Inputs
- Ids
idslist - Return only the leaves with these ids.
- Employee ids
employee_idslist - Return only the leaves of these employees.
- Leave type
leave_type_idlist - Return only the leaves of these leave types. Despite the singular name it takes a list.
- To
todate - Return only the leaves that had already started by this date (start date on or before it). Usable on its own; pair it with `from` for a window.
- From
from_datedate - Return only the leaves that had not finished before this date, meaning they end on or after it or have no end date at all. Usable on its own; pair it with `to` for a window.
- Only active
only_activetrue/false - Retrieve only active leaves
- Include deleted leaves
include_deleted_leavestrue/false - Whether to include deleted leaves (not included by default if not specified)
- Approved
approvedtrue/false - Set to true for leaves that were approved, false for leaves that were rejected. Leave it unset for every leave whatever its decision. Combining `approved: true` with `include_pending: true` returns approved and still-pending leaves together.
- Include pending
include_pendingtrue/false - Set to true to include leaves still awaiting a decision. On its own it returns ONLY the pending ones; alongside `approved: true` it returns approved and pending together.
- Include leave type
include_leave_typetrue/false - Retrieve leave types
- Include duration
include_durationtrue/false - Retrieve leave duration
- Include duration by day
include_duration_by_daytrue/false - Retrieve the per-day breakdown of the leave's duration (`duration_by_day_attributes`)
- Type is workable
type_is_workabletrue/false - Set to true for leaves whose leave type counts as worked time, false for those that do not. Leave it unset to get both.
- Type is payable
type_is_payabletrue/false - Set to true for leaves whose leave type is paid, false for unpaid ones. Leave it unset to get both.
- Forced finish on
forced_finish_ondate - Caps the per-day duration walk at this date. For endless leaves (`finish_on = nil`) it pins the walk end; for closed leaves whose `finish_on` sits past this date it truncates the walk. Never extends a leave past its real `finish_on`. Must fall inside the read window (from/to or overlaps_range_from/overlaps_range_to).
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List legal entities
List legal entities in the connected company.
Inputs
- Ids
idslist - Return only the legal entities with these ids.
- Employees ids
employees_idslist - identifier of the employees asigned to the legal entity
- Companies ids
companies_idslist - identifier of the companies to which the legal entity belongs
- Country ids
country_idslist - country code of the legal entity
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List locations
List locations in the connected company.
Inputs
- Ids
idslist - The location IDs to filter the results.
- Employee ids
employee_idslist - Return only the locations assigned to these employees.
- Main
maintrue/false - Set to true to return only the company's main location. Passing false has no effect.
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List shifts
List shifts in the connected company.
Inputs
- Employee ids
employee_idslist - Return only the shifts of these employees.
- Start on
start_ondate - Return only the shifts whose reference date (the day the shift counts towards, which for an overnight shift is the day it started) is on or after this date. Can be given on its own, as an open-ended lower bound.
- End on
end_ontext - Return only the shifts whose reference date is on or before this date. Can be given on its own, as an open-ended upper bound.
- Ids
idslist - Return only the shifts with these ids.
- Half day
half_daytrue/false - Set to true to return only the shifts marked as covering half a day. Passing false has no effect: it does not exclude them.
- Workable
workabletrue/false - Set to true for worked time only, false for the non-workable entries (breaks). Leave it unset to get both.
- Latest shift
latest_shifttrue/false - Flag to filter only the latest shift for each employee
- Sort created at asc
sort_created_at_asctrue/false - Flag to sort by created_at asc
- Breaks with time configuration
breaks_with_time_configurationtrue/false - Flag to include breaks with time configuration
- Last working shift
last_working_shifttrue/false - Filter by last working shift
- Updated on or after
updated_atdate - Filter shifts by the date they were last updated
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}List teams
List teams in the connected company.
Inputs
- Ids
idslist - Return only the teams with these ids.
- Limit
limitnumber - Records per page, up to 100.From 1 to 100.
- After id
after_idtext - The next cursor returned by an earlier page.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"meta": {
"end_cursor": "example",
"has_next_page": false,
"has_previous_page": false,
"limit": 0,
"start_cursor": "example",
"total": 0
}
},
"has_more": false,
"next_cursor": null
}