Skip to main content
GET
/
companies
/
{companyId}
/
employees
/
{employeeId}
/
limits
Get employee limits
curl --request GET \
  --url https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://pre-partners-api.cobee.io/api/v3/companies/{companyId}/employees/{employeeId}/limits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "company": {
    "id": "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
    "legalId": "B12345678",
    "currency": "EUR",
    "employee": {
      "employeeId": "dd3de3a0-f903-42a0-b729-4cb16f185bc6",
      "internalId": "12345",
      "legalId": "129387655X",
      "limits": {
        "meal": {
          "amount": {
            "amountInCents": 1,
            "currency": "EUR"
          },
          "period": "payroll",
          "type": "recurrent",
          "disabled": false
        },
        "transport": {
          "amount": {
            "amountInCents": 1,
            "currency": "EUR"
          },
          "period": "payroll",
          "type": "punctual",
          "disabled": false
        },
        "nursery": {
          "amount": {
            "amountInCents": 1,
            "currency": "EUR"
          },
          "period": "year",
          "type": "recurrent",
          "disabled": false
        }
      }
    },
    "payrollCycle": {
      "id": "7f4c9ba8-9c2d-4b82-8b8c-e5f8f8f8f8f8",
      "start": 1672531200,
      "end": 1675123200,
      "fiscalYear": "2023",
      "payrollMonth": "03"
    }
  }
}
{
  "message": "invalid_token"
}
{
  "message": "Company does not belong to the specified partner"
}

​
Overview

This endpoint allows you to retrieve the employee limits for all the benefits defined by the partner, such as meals, transport and nurseries. You must specify the payroll cycle to query using the required payroll query parameter (format YYYY-MM). Past payroll cycles are not allowed.
  • Current payroll cycle: If the parameter matches the current cycle, the response includes the current payroll cycle details.
  • Future payroll cycles: If the parameter is for a future payroll cycle, the payrollCycle object will have id/start/end: null, as the cycle has not yet opened.
  • Past payroll cycles: Querying for past payroll cycles is not allowed and will return a 400 Bad Request.
You can also filter the response by specific benefit categories using the categories query parameter. The response will include only the requested categories in the order they were provided. The response includes the appliesTo field for each benefit, indicating whether the limit applies to the employee or a child, along with the amount.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Accept
enum<string>

The response file type. It can be application/json or text/csv.

Available options:
application/json,
text/csv

Path Parameters

​
companyId
string<uuid>
required

The company identifier

​
employeeId
string
required

The employee identifier

Query Parameters

​
payroll
string
required

The fiscal year and month (YYYY-MM) of the payroll cycle the limits belong to (e.g. 2025-03). Past payroll cycles are not allowed.

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$
Example:

"2025-03"

​
categories
string

List of benefit categories to include in the response, which will return them in the same order as requested.

​
csvFormat
enum<string>
default:lines

The format of the resulting limits. Only applicable when Accept is text/csv.

  • lines: One row per limit (default).
  • columns: One row per employee, with columns for each benefit category (amount and appliesTo).
Available options:
lines,
columns

Response

Employee limits

​
company
object
required