---
title: List tenant entitlements
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Tenants](https://developers.cloudflare.com/api/resources/tenants)
[Entitlements](https://developers.cloudflare.com/api/resources/tenants/subresources/entitlements)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List tenant entitlements
GET/tenants/{tenant\_id}/entitlements
Retrieves the innate and custom entitlement allocations available to this tenant.
##### Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**`X-Auth-Email: user@example.com`
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`
##### P ath ParametersExpand Collapse
tenant\_id: string
[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20tenant_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of unknown
[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: TenantEntitlements { allow\_add\_subdomain, allow\_auto\_accept\_invites, cname\_setup\_allowed, 3 more }
allow\_add\_subdomain: object {type, value }
type: "bool"
Link to this property
value: boolean
Link to this property
Link to this property
allow\_auto\_accept\_invites: object {type, value }
type: "bool"
Link to this property
value: boolean
Link to this property
Link to this property
cname\_setup\_allowed: object {type, value }
type: "bool"
Link to this property
value: boolean
Link to this property
Link to this property
custom\_entitlements: array of object {allocation, feature }
allocation: object {type, value } or object {type, value } or object {type, value }
One of the following:
OrganizationsAPIMaxCountAllocation object {type, value }
type: "max\_count"
Link to this property
value: number
Link to this property
Link to this property
OrganizationsAPIBoolAllocation object {type, value }
type: "bool"
Link to this property
value: boolean
Link to this property
Link to this property
OrganizationsAPINullAllocation object {type, value }
type: ""
Link to this property
value: optional unknown
Link to this property
Link to this property
Link to this property
feature: object {key }
key: string
Link to this property
Link to this property
Link to this property
mhs\_certificate\_count: object {type, value }
type: "max\_count"
Link to this property
value: number
Link to this property
Link to this property
partial\_setup\_allowed: object {type, value }
type: "bool"
Link to this property
value: boolean
Link to this property
Link to this property
[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### List tenant entitlements
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/tenants/$TENANT_ID/entitlements \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY"
```
200 example
```
{
"errors": [],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"allow_add_subdomain": {
"type": "bool",
"value": true
},
"allow_auto_accept_invites": {
"type": "bool",
"value": true
},
"cname_setup_allowed": {
"type": "bool",
"value": true
},
"custom_entitlements": [
{
"allocation": {
"type": "max_count",
"value": 0
},
"feature": {
"key": "key"
}
}
],
"mhs_certificate_count": {
"type": "max_count",
"value": 0
},
"partial_setup_allowed": {
"type": "bool",
"value": true
}
},
"success": true
}
```
##### Returns Examples
200 example
```
{
"errors": [],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"result": {
"allow_add_subdomain": {
"type": "bool",
"value": true
},
"allow_auto_accept_invites": {
"type": "bool",
"value": true
},
"cname_setup_allowed": {
"type": "bool",
"value": true
},
"custom_entitlements": [
{
"allocation": {
"type": "max_count",
"value": 0
},
"feature": {
"key": "key"
}
}
],
"mhs_certificate_count": {
"type": "max_count",
"value": 0
},
"partial_setup_allowed": {
"type": "bool",
"value": true
}
},
"success": true
}
```