Skip to main content
GET
Get Entitlement

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

id
string
required

The resource ID

Response

200 - application/json

OK

aggregator_type
string

The aggregator type of the entitlement

id
string

The ID of the entitlement

key
string

The key of the entitlement

name
string

The name of the entitlement

possible_values
string[]

The possible values of the entitlement if the type is ENUM or MULTI_ENUM

type
string

The type of the entitlement that can be BOOL, TEXT, NUMBER, ENUM, or MULTI_ENUM