Skip to main content
GET
/
companies
/
{companyId}
/
employees
Get employees
curl --request GET \
  --url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees \
  --header 'Authorization: Bearer <token>'
{
  "employees": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "legalId": "<string>",
      "name": "<string>",
      "surname": "<string>",
      "birthDate": "2023-12-25",
      "grossSalary": {
        "amountInCents": 4500000,
        "currency": "EUR"
      },
      "hiringDate": "2023-12-25",
      "taxRegime": "general",
      "workdayConfiguration": {
        "daysPerMonth": 22,
        "workTimePercentage": 100,
        "numberOfPaychecks": 14,
        "collectiveAgreementSalary": {
          "amountInCents": 3800000,
          "currency": "EUR"
        }
      },
      "internalId": "<string>",
      "modelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": "not-active",
      "costCenter": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "payrollCompany": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "metadata": {}
    }
  ],
  "page": {
    "size": 123,
    "totalElements": 123,
    "totalPages": 123,
    "number": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.partners.api.cobee.io/llms.txt

Use this file to discover all available pages before exploring further.

Overview

This endpoint allows you to retrieve detailed information about all employees in the Cobee system. It returns comprehensive data including personal information, salary details, workday configuration, and benefit-related information.

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

The unique identifier of the company

Query Parameters

email
string<email>

Employee email to filter by

Employee legal ID to filter by

internalId
string

Employee internal ID to filter by

state
enum<string>

Employee state to filter by

Available options:
not-active,
active,
removed,
blocked
page
integer
default:1

Page number to retrieve. Defaults to 1.

Required range: x >= 1
limit
integer
default:250

Max number of items per page. Must be greater than 0. Defaults to 250.

Required range: x >= 1

Response

Employees successfully retrieved

employees
object[]
page
object