---
title: List tenant entitlements
---

[Skip to content](#%5Ftop) 

[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

List of innate entitlements available for the 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`

##### Path ParametersExpand Collapse 

tenant\_id: string

##### ReturnsExpand Collapse 

errors: array of unknown

messages: array of [ResponseInfo](https://developers.cloudflare.com/api/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20response%5Finfo%20%3E%20%28schema%29) { code, message, documentation\_url, source } 

code: number

minimum1000

message: string

documentation\_url: optional string

source: optional object { pointer } 

pointer: optional string

result: [TenantEntitlements](https://developers.cloudflare.com/api/resources/tenants#%28resource%29%20tenants.entitlements%20%3E%20%28model%29%20tenant%5Fentitlements%20%3E%20%28schema%29) { allow\_add\_subdomain, allow\_auto\_accept\_invites, cname\_setup\_allowed, 3 more } 

allow\_add\_subdomain: object { type, value } 

type: "bool"

value: boolean

allow\_auto\_accept\_invites: object { type, value } 

type: "bool"

value: boolean

cname\_setup\_allowed: object { type, value } 

type: "bool"

value: boolean

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"

value: number

OrganizationsAPIBoolAllocation object { type, value } 

type: "bool"

value: boolean

OrganizationsAPINullAllocation object { type, value } 

type: ""

value: optional unknown

feature: object { key } 

key: string

mhs\_certificate\_count: object { type, value } 

type: "max\_count"

value: number

partial\_setup\_allowed: object { type, value } 

type: "bool"

value: boolean

success: true

### List tenant entitlements

HTTP

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
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
}
```