Skip to main content
GET
/
companies
/
{companyId}
/
benefit-models
Get all benefit models for a the company
curl --request GET \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/benefit-models \
  --header 'Authorization: Bearer <token>'
{
  "benefitModels": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "benefitBagConfigs": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "allowedFor": [
            "education-benefit"
          ],
          "consumableFrom": "2023-12-25",
          "limitAmount": {
            "amountInCents": 4500000,
            "currency": "EUR"
          }
        }
      ]
    }
  ]
}

​
Overview

Retrieve a list with all the benefit models available for the company of the authenticated user.

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

Response

List of benefit models successfully retrieved

​
benefitModels
object[]
required

List of benefit models