Skip to main content
GET
/
companies
/
{companyId}
/
benefit-models
/
{benefitModelId}
Get the information of a benefit model
curl --request GET \
  --url https://pre-public-api.cobee.io/api/v3/companies/{companyId}/benefit-models/{benefitModelId} \
  --header 'Authorization: Bearer <token>'
{
  "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 the information of a single benefit model in the Cobee system.

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

​
benefitModelId
string<uuid>
required

The unique identifier of the benefit model

Response

Benefit model successfully retrieved

​
id
string<uuid>

The identifier of the benefit model

​
name
string

The name of the benefit model

​
benefitBagConfigs
object[]