Skip to main content
GET
/
companies
/
{companyId}
/
employees
Get Employees
curl --request GET \
  --url https://app.essentry.com/api/v2/companies/{companyId}/employees \
  --header 'Authorization: Bearer <token>'
{
  "employees": [
    {
      "id": 123,
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "language": "DE",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "totalCount": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
companyId
integer
required

The ID of the company that the employees work for

Query Parameters

​
limit
integer
default:20

Pagination - How many results to return

Required range: x <= 50
​
offset
integer
default:0

Pagination - How many results to skip

​
sortField
enum<string>
Available options:
EMAIL
​
sortAscending
boolean
​
searchQuery
string

Only return employees whose name or email match this string

Response

200 - application/json

The request has succeeded.

​
employees
object[]
required
​
pageInfo
object
required