Get employees

Get employees

curl --request GET \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/employees \
  --header 'Authorization: Bearer <token>'

{
  "employees": [
    {
      "id": "<string>",
      "email": "[email protected]",
      "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": "<string>",
      "payrollCompany": "<string>",
      "metadata": {}
    }
  ],
  "page": {
    "size": 123,
    "totalElements": 123,
    "totalPages": 123,
    "number": 123
  }
}

GET

companies

{companyId}

employees

Get employees

curl --request GET \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/employees \
  --header 'Authorization: Bearer <token>'

{
  "employees": [
    {
      "id": "<string>",
      "email": "[email protected]",
      "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": "<string>",
      "payrollCompany": "<string>",
      "metadata": {}
    }
  ],
  "page": {
    "size": 123,
    "totalElements": 123,
    "totalPages": 123,
    "number": 123
  }
}

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

string<email>

Employee email to filter by

legalId

string

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[]

Show child attributes

employees.id

string

required

The unique identifier of the employee

employees.email

string<email>

required

The employee's email address

employees.legalId

string

required

The employee's legal identifier

employees.name

string

required

The employee's first name

employees.surname

string

required

The employee's surname

employees.birthDate

string<date>

required

The employee's date of birth in ISO 8601 format (YYYY-MM-DD)

employees.grossSalary

object

required

The employee's gross salary details

Show child attributes

employees.grossSalary.amountInCents

integer

required

The monetary amount in cents (e.g., 4500000 for 45,000)

Required range: x >= 1

employees.grossSalary.currency

string

required

The currency code (e.g., EUR)

Example:

"EUR"

Example:

{
  "amountInCents": 4500000,
  "currency": "EUR"
}

employees.hiringDate

string<date>

required

The date when the employee was hired in ISO 8601 format (YYYY-MM-DD)

employees.taxRegime

enum<string>

required

The employee's tax regime

Available options:

general,

basque,

navarrese,

biscayan

employees.workdayConfiguration

object

required

Configuration of the employee's workday

Show child attributes

employees.workdayConfiguration.workTimePercentage

number

required

The percentage of a full-time schedule this employee works

Required range: 0.01 <= x <= 100

Example:

100

employees.workdayConfiguration.daysPerMonth

integer

The number of working days per month for this employee

Example:

22

employees.workdayConfiguration.numberOfPaychecks

integer

The number of salary payments the employee receives per year

Example:

14

employees.workdayConfiguration.collectiveAgreementSalary

object

The salary established by the collective agreement, if applicable

Show child attributes

employees.workdayConfiguration.collectiveAgreementSalary.amountInCents

integer

required

The monetary amount in cents (e.g., 4500000 for 45,000)

Required range: x >= 1

employees.workdayConfiguration.collectiveAgreementSalary.currency

string

required

The currency code (e.g., EUR)

Example:

"EUR"

Example:

{
  "amountInCents": 4500000,
  "currency": "EUR"
}

Example:

{
  "daysPerMonth": 22,
  "workTimePercentage": 100,
  "numberOfPaychecks": 14,
  "collectiveAgreementSalary": {
    "amountInCents": 3800000,
    "currency": "EUR"
  }
}

employees.internalId

string

required

Your internal identifier for the employee

employees.modelId

string<uuid>

required

The ID of the benefit model assigned to this employee

employees.state

enum<string>

required

The current state of the employee

Available options:

not-active,

active,

removed,

blocked

employees.costCenter

string

The cost centre associated with this employee

employees.payrollCompany

string

The company handling the employee's payroll, if different from the main company

employees.metadata

object

Additional metadata for the employee (key-value pairs)

page

object

Show child attributes

page.size

integer

required

Number of items in the current page

page.totalElements

integer

required

Total number of elements available across all pages

page.totalPages

integer

required

Total number of pages available

page.number

integer

required

Current page number (1-indexed)

Get employee Update employee

⌘I

Get Started

Guides

Data Models

Authentication

Companies

Employees

Consumption Reports

Benefit Models

Payroll Cycles

Overview

Authorizations

Path Parameters

Query Parameters

Response

Get Started

Guides

Data Models

Authentication

Companies

Employees

Consumption Reports

Benefit Models

Payroll Cycles

​Overview

Authorizations

Path Parameters

Query Parameters

Response

Overview