--- title: Tenants --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Tenants ##### [Get tenant details](https://developers.cloudflare.com/api/resources/tenants/methods/get) GET/tenants/{tenant\_id} ##### ModelsExpand Collapse

Tenant object {cdate, edate, tenant\_contacts, 9 more }

cdate: string formatdate-time Link to this property edate: string formatdate-time Link to this property

tenant\_contacts: object {email, website }

email: optional string Link to this property website: optional string Link to this property

Link to this property tenant\_labels: array of string Link to this property

tenant\_metadata: object {dns }

dns: optional object {ns\_pool }

ns\_pool: object {primary, secondary }

primary: optional string Link to this property secondary: optional string Link to this property

Link to this property

Link to this property tenant\_name: string Link to this property tenant\_network: unknown Link to this property tenant\_status: string Link to this property tenant\_tag: string Link to this property tenant\_type: string Link to this property

tenant\_units: array of object {unit\_memberships, unit\_metadata, unit\_name, 2 more }

unit\_memberships: array of unknown Link to this property unit\_metadata: unknown Link to this property unit\_name: string Link to this property unit\_status: string Link to this property unit\_tag: string Link to this property

Link to this property customer\_id: optional string Link to this property

[Link to this property](<#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)>) #### TenantsAccount Types ##### [List tenant account types](https://developers.cloudflare.com/api/resources/tenants/subresources/account_types/methods/list) GET/tenants/{tenant\_id}/account\_types ##### ModelsExpand Collapse AccountTypeListResponse = string [Link to this property](<#(resource)%20tenants.account_types%20%3E%20(model)%20account_type_list_response%20%3E%20(schema)>) #### TenantsAccounts ##### [List tenant accounts](https://developers.cloudflare.com/api/resources/tenants/subresources/accounts/methods/list) GET/tenants/{tenant\_id}/accounts ##### ModelsExpand Collapse

TenantAccount object {id, created\_on, name, 3 more }

id: string Link to this property created\_on: string formatdate-time Link to this property name: string Link to this property

settings: object {abuse\_contact\_email, access\_approval\_expiry, api\_access\_enabled, 3 more }

abuse\_contact\_email: string Link to this property access\_approval\_expiry: string formatdate-time Link to this property api\_access\_enabled: boolean Link to this property Deprecateddefault\_nameservers: string Use DNS Settings instead. Deprecated. Link to this property enforce\_twofactor: boolean Link to this property Deprecateduse\_account\_custom\_ns\_by\_default: boolean Use DNS Settings instead. Deprecated. Link to this property

Link to this property

type: "standard"or "enterprise"

One of the following: "standard" Link to this property "enterprise" Link to this property

Link to this property tags: optional map\[string] Account tags, present only when include_tags=true is requested. Link to this property

[Link to this property](<#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)>) #### TenantsEntitlements ##### [List tenant entitlements](https://developers.cloudflare.com/api/resources/tenants/subresources/entitlements/methods/get) GET/tenants/{tenant\_id}/entitlements ##### ModelsExpand Collapse

TenantEntitlements object {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

feature: object {key }

key: string 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(model)%20tenant_entitlements%20%3E%20(schema)>) #### TenantsMemberships ##### [List tenant memberships](https://developers.cloudflare.com/api/resources/tenants/subresources/memberships/methods/list) GET/tenants/{tenant\_id}/memberships ##### ModelsExpand Collapse

TenantMembership object {user\_email, user\_name, user\_tag }

user\_email: string Link to this property user\_name: string Link to this property user\_tag: string Link to this property

[Link to this property](<#(resource)%20tenants.memberships%20%3E%20(model)%20tenant_membership%20%3E%20(schema)>)