--- title: List tenant entitlements --- [Skip to content](#_top) [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]() 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` ##### ParametersExpand Collapse tenant\_id: str [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
class TenantEntitlements: …
allow\_add\_subdomain: AllowAddSubdomain type: Literal\["bool"] Link to this property value: bool Link to this property
Link to this property
allow\_auto\_accept\_invites: AllowAutoAcceptInvites type: Literal\["bool"] Link to this property value: bool Link to this property
Link to this property
cname\_setup\_allowed: CNAMESetupAllowed type: Literal\["bool"] Link to this property value: bool Link to this property
Link to this property
custom\_entitlements: Optional\[List\[CustomEntitlement]]
allocation: CustomEntitlementAllocation One of the following:
class CustomEntitlementAllocationOrganizationsAPIMaxCountAllocation: … type: Literal\["max\_count"] Link to this property value: int Link to this property
Link to this property
class CustomEntitlementAllocationOrganizationsAPIBoolAllocation: … type: Literal\["bool"] Link to this property value: bool Link to this property
Link to this property
class CustomEntitlementAllocationOrganizationsAPINullAllocation: … type: Literal\[""] Link to this property value: Optional\[object] Link to this property
Link to this property
Link to this property
feature: CustomEntitlementFeature key: str Link to this property
Link to this property
Link to this property
mhs\_certificate\_count: MhsCertificateCount type: Literal\["max\_count"] Link to this property value: int Link to this property
Link to this property
partial\_setup\_allowed: PartialSetupAllowed type: Literal\["bool"] Link to this property value: bool Link to this property
Link to this property
[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)>) ### List tenant entitlements Python HTTPTypeScriptPythonGoTerraform ``` 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 } ```