---
title: List tenant entitlements
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/python)

[Tenants](https://developers.cloudflare.com/api/python/resources/tenants)

[Entitlements](https://developers.cloudflare.com/api/python/resources/tenants/subresources/entitlements)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# List tenant entitlements

tenants.entitlements.get(strtenant\_id)  \-> [TenantEntitlements](https://developers.cloudflare.com/api/python/resources/tenants#%28resource%29%20tenants.entitlements%20%3E%20%28model%29%20tenant%5Fentitlements%20%3E%20%28schema%29)

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`

##### ParametersExpand Collapse 

tenant\_id: str

##### ReturnsExpand Collapse 

class TenantEntitlements: …

allow\_add\_subdomain: AllowAddSubdomain

type: Literal\["bool"\]

value: bool

allow\_auto\_accept\_invites: AllowAutoAcceptInvites

type: Literal\["bool"\]

value: bool

cname\_setup\_allowed: CNAMESetupAllowed

type: Literal\["bool"\]

value: bool

custom\_entitlements: Optional\[List\[CustomEntitlement\]\]

allocation: CustomEntitlementAllocation

One of the following:

class CustomEntitlementAllocationOrganizationsAPIMaxCountAllocation: …

type: Literal\["max\_count"\]

value: int

class CustomEntitlementAllocationOrganizationsAPIBoolAllocation: …

type: Literal\["bool"\]

value: bool

class CustomEntitlementAllocationOrganizationsAPINullAllocation: …

type: Literal\[""\]

value: Optional\[object\]

feature: CustomEntitlementFeature

key: str

mhs\_certificate\_count: MhsCertificateCount

type: Literal\["max\_count"\]

value: int

partial\_setup\_allowed: PartialSetupAllowed

type: Literal\["bool"\]

value: bool

### List tenant entitlements

Python

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
tenant_entitlements = client.tenants.entitlements.get(
    "tenant_id",
)
print(tenant_entitlements.allow_add_subdomain)
```

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