List All Employees

get

https://{orangehrm-url}/api/v2/pim/employees

This endpoint allows you to get a list of employees.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

length ≤ 100

Specify an employee name

nameOrId

string

length ≤ 100

Specify an employee name or employee ID

employeeId

integer

Specify an employee ID

jobTitleId

integer

Specify a job title ID

subunitId

integer

Specify a subunit ID

empStatusId

integer

Specify an employee status ID

includeEmployees

integer

enum

Specify whether to search current employees, past employees or all employees

Allowed:

model

string

enum

Defaults to default

Specify whether the result should be default or detailed

Allowed:

sortField

string

enum

Sort the employee list by last name, first name, middle name, employee number, employee ID, job title name, employee status name, subunit name or supervisor's first name

sortOrder

string

enum

Specify whether to sort in ascending or descending order

Allowed:

limit

integer

Defaults to 50

Limit the number of responses from the endpoint

offset

integer

Defaults to 0

Specify the starting point of the collection

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success