Skip to main content
POST
/
companies
/
{company_id}
/
entitlements
/
find
Find Entitlements
curl --request POST \
  --url https://api.maplebilling.com/api/v1/companies/{company_id}/entitlements/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 20
  },
  "include_meta": true,
  "query": {
    "aggregator_type": "<unknown>",
    "key": "<unknown>",
    "name": "<unknown>",
    "search": "<unknown>",
    "type": "<unknown>"
  },
  "sort_key": "createdAtDesc"
}
'
{
  "pagination": {
    "from_key": "<unknown>",
    "limit": 123
  },
  "results": [
    {
      "aggregator_type": "<string>",
      "id": "<string>",
      "key": "<string>",
      "name": "<string>",
      "possible_values": [
        "<string>"
      ],
      "type": "<string>"
    }
  ]
}

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_'.

Body

application/json
​
pagination
object
required

The pagination parameters for the request

​
include_meta
boolean | null

Whether to include additional metadata in the pagination response such the number of total results

​
query
object

The query criteria for the request

​
sort_key
enum<string>
default:createdAtDesc
Available options:
createdAtDesc,
createdAtAsc,
updatedAtAsc,
updatedAtDesc

Response

200 - application/json

OK

​
pagination
object
​
results
object[] | null