v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Employees > Employee

Reads all Employees

Only admins can see all the employees' information, regular users will get a restricted version of the payload as a response based on the permission set by the admin

get/api/2026-07-01/resources/employees/employees

Query parameters

ids[]string[]

filter by employee ids.

[
  "1",
  "2",
  "3"
]

access_ids[]string[]

filter by employee access ids.

[
  "1",
  "2",
  "3"
]

emails[]string[]

filter by employee emails.

[
  "ana@factorial.com",
  "john@factorial.com"
]

full_text_namestring

filter by employee name.

Example:Ana Lopez Perez

filter by employee name.

updated_at_gteqstring

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.

Example:2024-01-01

legal_entity_ids[]string[]

filter by legal entity id (refereces to companies/legal_entities).

[
  "1",
  "2"
]

company_identifierstring

filter by employee company identifier.

Example:bb9d281e

filter by employee company identifier.

only_activeboolean required

get only active employees

Example:true

get only active employees

team_ids[]string[]

filter employees by team id (references to core/teams).

[
  "1",
  "2"
]

location_ids[]string[]

filter employees by location id (references to locations/location).

[
  "1",
  "2"
]

only_managersboolean required

get only manager employees.

Example:true

get only manager employees.

name_starts_withstring

filter by employee names that start with the given text.

Example:Ana

filter by employee names that start with the given text.

Response

Example response

{
  "data": [
    {
      "id": "2",
      "access_id": "1",
      "first_name": "Ana",
      "last_name": "Blanco Perez",
      "full_name": "Ana Blanco Perez",
      "preferred_name": "Anita",
      "birth_name": "Anna",
      "gender": "female",
      "identifier": "QKG587532Y",
      "identifier_type": "passport",
      "email": "ana@factorial.com",
      "login_email": "ana@factorial.com",
      "birthday_on": "1990-06-06",
      "nationality": "es",
      "address_line_1": "Calle Adaro 10 1 A",
      "address_line_2": "Calle Adaro 10 1 A",
      "postal_code": "27004",
      "city": "Santander",
      "state": "Cantabria",
      "country": "es",
      "bank_number": "ES6220809324751871912999",
      "swift_bic": "CAGLES2M510",
      "bank_number_format": "iban",
      "company_id": "1",
      "legal_entity_id": "1",
      "location_id": "1",
      "default_work_area_id": "1",
      "created_at": "2010-10-06T00:00:00.000Z",
      "updated_at": "2024-10-06T00:00:00.000Z",
      "social_security_number": "150126298420",
      "terminated_on": "2024-10-06",
      "termination_reason_type": "others",
      "termination_reason": "The employee has left the company",
      "termination_observations": "Ana has been working on this project before she left",
      "manager_id": "1",
      "timeoff_manager_id": "1",
      "phone_number": "657483987",
      "company_identifier": "bb9d281e",
      "age_number": 30,
      "termination_type_description": "Baja voluntaria/Dimisión",
      "contact_name": "Laura Delgado",
      "contact_number": "647384950",
      "personal_email": "ana@factorial.com",
      "seniority_calculation_date": "2024-10-07",
      "communications_email": "employee@company.com",
      "unconfirmed_communications_email": "new-email@example.com",
      "pronouns": "She/Her",
      "active": true,
      "disability_percentage_cents": 1200,
      "identifier_expiration_date": "2023-12-31",
      "attendable": true,
      "country_of_birth": "Spain",
      "birthplace": "Barcelona"
    }
  ]
}