Sign in

v1

latestOpenAPI 3.0.02026-07-13483586.3 KB
Employees
Pagination
Search

List all employees

get/employees

Query parameters

group'ACTIVE' | 'INVOLVED' | 'JOBLESS' | 'DEPARTING' | 'NEW_HIRES' | 'PAST'

Filter employees by special groups

employeeNamestring

Filter employees by name

Example:John Doe

Filter employees by name

departmentIdstring

Filter employees by department ID

Example:123

Filter employees by department ID

skillsstring

Filter employees by skills according to skillsFiltering

Example:JavaScript,React

Filter employees by skills

skillsFiltering'ANY' | 'ALL'

If more than one skill is passed, return either employees with any of the skills (ANY) or with all of them (ALL)

Example:ALL

How to match employee skills

salaryFromstring

Minimum salary amount

Example:5000

Minimum salary amount

salaryTostring

Maximum salary amount

Example:10000

Maximum salary amount

nationality'US' | 'UK' | 'FR' | 'DE' | 'NL' | 'PL' | 'IT' | 'ES' | 'IN'

Nationality of employee as an ISO 3166-1 alpha-2 country code

Example:US

Filter employees by nationality (country code, e.g. US, PL)

pagenumber

Page number to retrieve

Example:1

Specify the page number to retrieve

pageSizenumber

Number of elements per page

Example:1

Specify the number of items per page

Response

Successful operation

idinteger required
nationality'US' | 'UK' | 'FR' | 'DE' | 'NL' | 'PL' | 'IT' | 'ES' | 'IN' required

Nationality of employee as an ISO 3166-1 alpha-2 country code

departmentstring required

Department display name

departmentIdinteger

Department ID for linking to getDepartmentById (enables EmployeeDepartmentLink)

keycardIdstring required
officestring required
officeCodestring required
namestring required
positionstring required
accountstring required
emailstring email required

Email address string

skillsSkill[] required
biostring required
imgURLstring

Example response

[
  {
    "id": 1234,
    "nationality": "DE",
    "department": "Marketing",
    "departmentId": 1,
    "officeCode": "de-berlin",
    "keycardId": "KC-9876",
    "account": "DE89 3704 0044 0532 0130 00",
    "name": "Hans Schmidt",
    "position": "Senior Developer",
    "email": "hans.schmidt@itcorpo.com",
    "skills": [
      "JavaScript",
      "TypeScript",
      "React"
    ],
    "bio": "Experienced developer with focus on frontend technologies",
    "imgURL": "hans-schmidt-profile.jpg",
    "employment": {
      "contractType": "PERMANENT",
      "currentSalary": 75000,
      "startDate": "2020-01-15",
      "endDate": "2025-01-14",
      "employedFor": {
        "years": 5,
        "months": 0,
        "days": 0
      }
    },
    "personalInfo": {
      "age": 35,
      "phone": "+49 123 456789",
      "email": "hans.schmidt@gmail.com",
      "dateOfBirth": "1988-05-20T00:00:00.000Z",
      "address": {
        "street": "Alexanderplatz 1",
        "city": "Berlin",
        "country": "Germany"
      }
    }
  }
]