Skip to main content
GET
/
v1
/
org
/
employees
Get Employees
curl --request GET \
  --url https://api.twine.se/v1/org/employees \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
      "org_id": "018eae56-8f9d-7ca0-bea3-17f3db6cf75b",
      "employee_mappings": [
        {
          "employee_id": "<string>",
          "external_id": "<string>",
          "id": "<string>",
          "inserted_at": "2023-11-07T05:31:56Z",
          "status": "active",
          "status_updated_at": "2023-11-07T05:31:56Z",
          "system_integration_id": "<string>",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "inserted_at": "2021-06-01T12:00:00Z",
      "organizational_unit_mappings": [
        {
          "employee_id": "<string>",
          "external_employee_id": "<string>",
          "external_organizational_unit_id": "<string>",
          "id": "<string>",
          "organizational_unit_id": "<string>"
        }
      ],
      "properties": {
        "lead_in_unit_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "bank_clearing_nr": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "cost_center_2": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_line_1": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "org_unit_type": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_payout_frequency": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "bank_bic": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_state": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "source_organizational_unit_external_ids": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_country_iso": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "position_code": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "office_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "variable_pay_currency": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "org_unit_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_type_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "manager_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_category_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "bank_swift": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_postal_code": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "ssn": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "variable_pay_period": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_line_1": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_type_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_termination_date": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "company_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_rate": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "full_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_amount": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "manager_email1": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_country": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "phone3": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "personal_id_number": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_line_3": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_leave_date": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "address_2_line_2": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_country": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_type_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "office_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "legal_entity_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_hire_date": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "salary_currency": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_tenure_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_start_date": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "tax_table_nr": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "bank_iban": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_city": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "subordinate_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_2_city": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "department_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_termination_reason": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "birthdate": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "company_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "custom_properties": {},
        "gender": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "variable_pay_amount": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "nationality": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "cost_center_1": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "location_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_probation_end_date": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "bank_country_iso": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "bank_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "manager_full_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "manager_email2": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_payout_day": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_payout_schedule": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "department_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "phone4": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "source_external_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "position_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "child_first_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_weekly_hours": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "legal_entity_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_line_2": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "phone1": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "manager_first_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "child_birthdate": [
          {
            "valid_from": "2021-06-01",
            "value": "2021-06-01T12:00:00Z"
          }
        ],
        "employee_no": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "tax_table_column": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "salary_period": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "team_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "phone2": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "is_manager": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "cost_center_1_weight": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "email1": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "manager_last_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "source_external_manager_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_postal_code": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "email2": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "middle_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "last_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_type_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "child_last_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "location_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "cost_center_2_weight": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "variable_pay_type_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_country_iso": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "variable_pay_type": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "position_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "bank_account_nr": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "team_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_state": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "org_unit_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "division_id": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_terminated": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_category_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "variable_pay_payout_frequency": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "first_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "active_status": [
          {
            "valid_from": "2021-06-01",
            "value": "active"
          }
        ],
        "division_name": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "address_1_line_3": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ],
        "employment_fte_weekly_hours": [
          {
            "valid_from": "2021-06-01",
            "value": null
          }
        ]
      },
      "source_system": "personio",
      "updated_at": "2021-06-01T12:00:00Z"
    }
  ],
  "pagination": {
    "end_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for authentication

Query Parameters

​
pagination
CursorPagination · object

Cursor pagination

​
filters
EmployeeFilter · object

Filter parameters for Employee Parameters for Employee filtering

​
order
EmployeeOrder · object

Parameters for Employee ordering

​
relations
enum<string>[]

Relations to select for Employee Parameters for Employee relations selection.

Available options:
employee_mappings,
organizational_unit_mappings
​
select
enum<string>[]

Select fields for Employee Parameters for Employee field selection. The actual type of properties.custom_properties will vary depending on your usage.

Note: id and org_id are always returned.

Available options:
id,
org_id,
updated_at,
inserted_at,
properties,
properties.source_external_id,
properties.source_external_manager_id,
properties.source_organizational_unit_external_ids,
properties.active_status,
properties.birthdate,
properties.personal_id_number,
properties.ssn,
properties.nationality,
properties.first_name,
properties.last_name,
properties.middle_name,
properties.full_name,
properties.gender,
properties.child_first_name,
properties.child_last_name,
properties.child_birthdate,
properties.email1,
properties.email2,
properties.phone1,
properties.phone2,
properties.phone3,
properties.phone4,
properties.address_1_line_1,
properties.address_1_line_2,
properties.address_1_line_3,
properties.address_1_postal_code,
properties.address_1_city,
properties.address_1_state,
properties.address_1_country,
properties.address_1_country_iso,
properties.address_2_line_1,
properties.address_2_line_2,
properties.address_2_line_3,
properties.address_2_postal_code,
properties.address_2_city,
properties.address_2_state,
properties.address_2_country,
properties.address_2_country_iso,
properties.tax_table_nr,
properties.tax_table_column,
properties.bank_name,
properties.bank_account_nr,
properties.bank_clearing_nr,
properties.bank_country_iso,
properties.bank_swift,
properties.bank_iban,
properties.bank_bic,
properties.employee_no,
properties.department_id,
properties.department_name,
properties.division_id,
properties.division_name,
properties.team_id,
properties.team_name,
properties.office_id,
properties.office_name,
properties.location_id,
properties.location_name,
properties.company_id,
properties.company_name,
properties.legal_entity_id,
properties.legal_entity_name,
properties.lead_in_unit_id,
properties.org_unit_id,
properties.org_unit_name,
properties.org_unit_type,
properties.cost_center_1,
properties.cost_center_2,
properties.cost_center_1_weight,
properties.cost_center_2_weight,
properties.manager_id,
properties.manager_first_name,
properties.manager_last_name,
properties.manager_full_name,
properties.manager_email1,
properties.manager_email2,
properties.subordinate_id,
properties.is_manager,
properties.salary_amount,
properties.salary_currency,
properties.salary_type_name,
properties.salary_type_id,
properties.salary_payout_day,
properties.salary_period,
properties.salary_payout_frequency,
properties.salary_payout_schedule,
properties.variable_pay_amount,
properties.variable_pay_currency,
properties.variable_pay_type,
properties.variable_pay_type_name,
properties.variable_pay_period,
properties.variable_pay_payout_frequency,
properties.employment_start_date,
properties.employment_hire_date,
properties.employment_leave_date,
properties.position_id,
properties.position_code,
properties.position_name,
properties.employment_probation_end_date,
properties.employment_type_id,
properties.employment_type_name,
properties.employment_tenure_name,
properties.employment_category_id,
properties.employment_category_name,
properties.employment_rate,
properties.employment_weekly_hours,
properties.employment_fte_weekly_hours,
properties.employment_terminated,
properties.employment_termination_reason,
properties.employment_termination_date,
properties.custom_properties,
properties.has_remote_entity
​
select_by_mapping
string

Select mapped fields by SystemIntegration ID. Specify "all" to aggregate all mappings defined in your organization. Overrides select. Note: id and org_id are always returned.

Response

Employee list Response

A paginated list of employees

​
data
Employee · object[]
required
​
pagination
CursorPaginationResult · object
required

Cursor pagination result