---
title: "List employees for a single entity"
method: GET
path: "/v1/employees"
tags: ["Employees"]
---

# List employees for a single entity

`GET /v1/employees`

## Request

- Base URL: `https://api.clients.wellhub.com`
- URL: `https://api.clients.wellhub.com/v1/employees`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/wellhub/apis/integrations-api/docs/v1/employees/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a paginated list of all employees belonging to the authenticated single-entity client. Use the `cursor` parameter to paginate through results.

## Query parameters

- `cursor` string

## Response `200`

OK. Returns a paginated list of employees.

- EmployeesResponse
  - `data` Employee[]: List of employees for the current page.
    - `id` string: Internal Wellhub identifier for the employee.
    - `full_name` string: Employee's full name.
    - `email` string: Employee's email address.
    - `employee_id` string: Client-defined employee identifier.
    - `national_id` string: Employee's national identifier (e.g. CPF in Brazil).
    - `invitation_status` string: Current invitation status for the employee on the Wellhub platform.
    - `mobile_number` string: Employee's mobile phone number.
    - `cost_center` string: Cost center associated with the employee.
    - `department` string: Department the employee belongs to.
    - `office_zip_code` string: ZIP code of the employee's office location.
    - `payroll_id` string: Payroll identifier for the employee.
    - `discount_subset_id` string, nullable: Identifier for the discount subset applicable to this employee, if any.
    - `employee_segment` string, nullable: Identifies the employee's segment for NR01, if set.
    - `eligible_to_payroll` boolean: Whether the employee is eligible for payroll deduction.
    - `deleted_at` string, date-time, nullable: Timestamp when the employee record was soft-deleted. `null` if active.
    - `updated_at` string, date-time: Timestamp of the last update to this employee record.
  - `cursor` string, nullable: Cursor for fetching the next page of results. `null` if there are no more results.

## Other responses

- `400`: Bad Request.
- `401`: Unauthorized. Missing or invalid Bearer token.
- `403`: Forbidden. The authenticated entity does not have access to this resource.
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/wellhub/apis/integrations-api.md) - [All operations](https://skmtc.dev/wellhub/apis/integrations-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wellhub/apis/integrations-api/revisions/3e6a46a18a2e?raw)