WEwellhub
Employees

List employees by company

Returns a paginated list of employees belonging to the specified company, identified by its tax ID. Only companies accessible to the authenticated entity are allowed.

ℹ️ Availability. This endpoint is available to multi-entity clients and channel partners. Single-entity clients should use GET /v1/employees instead.

get/v1/companies/{company-tax-id}/employees

Request

Path parameters

company-tax-idstring required

The tax ID of the company whose employees should be listed.

Query parameters

cursorstring

Pagination cursor returned from the previous response. Omit to retrieve the first page.

Response

OK. Returns a paginated list of employees.

cursorstring nullable

Cursor for fetching the next page of results. null if there are no more results.

Example response

{
  "data": [
    {
      "id": "abc123def456",
      "full_name": "Jane Doe",
      "email": "jane.doe@example.com",
      "employee_id": "EMP001",
      "national_id": "123.456.789-00",
      "invitation_status": "accepted",
      "mobile_number": "+5511999999999",
      "cost_center": "CC-001",
      "department": "Engineering",
      "office_zip_code": "01310-100",
      "payroll_id": "PAY-9876",
      "eligible_to_payroll": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.