---
title: Tenants
---

[Skip to content](#_top)

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

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/typescript/resources/tenants/methods/get)

client.tenants.get(stringtenantID, RequestOptionsoptions?): [Tenant](<https://developers.cloudflare.com/api/typescript/resources/tenants#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)>) {cdate, edate, tenant\_contacts, 9 more }

GET/tenants/{tenant\_id}

##### ModelsExpand Collapse

<details>

<summary>

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

</summary>

cdate: string

formatdate-time

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20cdate">Link to this property</a>

edate: string

formatdate-time

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20edate">Link to this property</a>

<details>

<summary>

tenant\_contacts: TenantContacts {email, website }

</summary>

email?: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_contacts%20%3E%20(property)%20email">Link to this property</a>

website?: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_contacts%20%3E%20(property)%20website">Link to this property</a>

</details>

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_contacts">Link to this property</a>

tenant\_labels: Array&lt;string&gt;

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_labels">Link to this property</a>

<details>

<summary>

tenant\_metadata: TenantMetadata {dns }

</summary>

<details>

<summary>

dns?: DNS {ns\_pool }

</summary>

<details>

<summary>

ns\_pool: NSPool {primary, secondary }

</summary>

primary?: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_metadata%20%3E%20(property)%20dns%20%3E%20(property)%20ns_pool%20%3E%20(property)%20primary">Link to this property</a>

secondary?: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_metadata%20%3E%20(property)%20dns%20%3E%20(property)%20ns_pool%20%3E%20(property)%20secondary">Link to this property</a>

</details>

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_metadata%20%3E%20(property)%20dns%20%3E%20(property)%20ns_pool">Link to this property</a>

</details>

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_metadata%20%3E%20(property)%20dns">Link to this property</a>

</details>

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_metadata">Link to this property</a>

tenant\_name: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_name">Link to this property</a>

tenant\_network: unknown

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_network">Link to this property</a>

tenant\_status: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_status">Link to this property</a>

tenant\_tag: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_tag">Link to this property</a>

tenant\_type: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_type">Link to this property</a>

<details>

<summary>

tenant\_units: Array&lt;TenantUnit&gt;

</summary>

unit\_memberships: Array&lt;unknown&gt;

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_units%20%3E%20(items)%20%3E%20(property)%20unit_memberships">Link to this property</a>

unit\_metadata: unknown

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_units%20%3E%20(items)%20%3E%20(property)%20unit_metadata">Link to this property</a>

unit\_name: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_units%20%3E%20(items)%20%3E%20(property)%20unit_name">Link to this property</a>

unit\_status: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_units%20%3E%20(items)%20%3E%20(property)%20unit_status">Link to this property</a>

unit\_tag: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_units%20%3E%20(items)%20%3E%20(property)%20unit_tag">Link to this property</a>

</details>

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20tenant_units">Link to this property</a>

customer\_id?: string

<a href="#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)%20%3E%20(property)%20customer_id">Link to this property</a>

</details>

[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/typescript/resources/tenants/subresources/account_types/methods/list)

client.tenants.accountTypes.list(stringtenantID, RequestOptionsoptions?): SinglePage< [AccountTypeListResponse](<https://developers.cloudflare.com/api/typescript/resources/tenants#(resource)%20tenants.account_types%20%3E%20(model)%20account_type_list_response%20%3E%20(schema)>)>

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/typescript/resources/tenants/subresources/accounts/methods/list)

client.tenants.accounts.list(stringtenantID, RequestOptionsoptions?): SinglePage< [TenantAccount](<https://developers.cloudflare.com/api/typescript/resources/tenants#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)>) {id, created\_on, name, 3 more } >

GET/tenants/{tenant\_id}/accounts

##### ModelsExpand Collapse

<details>

<summary>

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

</summary>

id: string

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

created\_on: string

formatdate-time

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20created_on">Link to this property</a>

name: string| null

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

<details>

<summary>

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

</summary>

abuse\_contact\_email: string| null

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings%20%3E%20(property)%20abuse_contact_email">Link to this property</a>

access\_approval\_expiry: string| null

formatdate-time

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings%20%3E%20(property)%20access_approval_expiry">Link to this property</a>

api\_access\_enabled: boolean| null

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings%20%3E%20(property)%20api_access_enabled">Link to this property</a>

Deprecateddefault\_nameservers: string| null

Use <a href="https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings">DNS Settings</a> instead. Deprecated.

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings%20%3E%20(property)%20default_nameservers">Link to this property</a>

enforce\_twofactor: boolean| null

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings%20%3E%20(property)%20enforce_twofactor">Link to this property</a>

Deprecateduse\_account\_custom\_ns\_by\_default: boolean| null

Use <a href="https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings">DNS Settings</a> instead. Deprecated.

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings%20%3E%20(property)%20use_account_custom_ns_by_default">Link to this property</a>

</details>

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20settings">Link to this property</a>

<details>

<summary>

type: "standard"| "enterprise"

</summary>

One of the following:

"standard"

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"enterprise"

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20type">Link to this property</a>

tags?: Record&lt;string, string&gt;

Account tags, present only when <code>include_tags=true</code> is requested.

<a href="#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)%20%3E%20(property)%20tags">Link to this property</a>

</details>

[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/typescript/resources/tenants/subresources/entitlements/methods/get)

client.tenants.entitlements.get(stringtenantID, RequestOptionsoptions?): [TenantEntitlements](<https://developers.cloudflare.com/api/typescript/resources/tenants#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)>) {allow\_add\_subdomain, allow\_auto\_accept\_invites, cname\_setup\_allowed, 3 more }

GET/tenants/{tenant\_id}/entitlements

##### ModelsExpand Collapse

<details>

<summary>

TenantEntitlements {allow\_add\_subdomain, allow\_auto\_accept\_invites, cname\_setup\_allowed, 3 more }

</summary>

<details>

<summary>

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

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_add_subdomain%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_add_subdomain%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_add_subdomain">Link to this property</a>

<details>

<summary>

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

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_auto_accept_invites%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_auto_accept_invites%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20allow_auto_accept_invites">Link to this property</a>

<details>

<summary>

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

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20cname_setup_allowed%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20cname_setup_allowed%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20cname_setup_allowed">Link to this property</a>

<details>

<summary>

custom\_entitlements: Array&lt;CustomEntitlement&gt;| null

</summary>

<details>

<summary>

allocation: OrganizationsAPIMaxCountAllocation {type, value } | OrganizationsAPIBoolAllocation {type, value } | OrganizationsAPINullAllocation {type, value }

</summary>

One of the following:

<details>

<summary>

OrganizationsAPIMaxCountAllocation {type, value }

</summary>

type: "max\_count"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%200%20%3E%20(property)%20type">Link to this property</a>

value: number

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%200%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%200">Link to this property</a>

<details>

<summary>

OrganizationsAPIBoolAllocation {type, value }

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%201%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%201%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%201">Link to this property</a>

<details>

<summary>

OrganizationsAPINullAllocation {type, value }

</summary>

type: ""

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%202%20%3E%20(property)%20type">Link to this property</a>

value?: unknown

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%202%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation%20%3E%20(variant)%202">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20allocation">Link to this property</a>

<details>

<summary>

feature: Feature {key }

</summary>

key: string

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20feature%20%3E%20(property)%20key">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements%20%3E%20(items)%20%3E%20(property)%20feature">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20custom_entitlements">Link to this property</a>

<details>

<summary>

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

</summary>

type: "max\_count"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20mhs_certificate_count%20%3E%20(property)%20type">Link to this property</a>

value: number

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20mhs_certificate_count%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20mhs_certificate_count">Link to this property</a>

<details>

<summary>

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

</summary>

type: "bool"

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20partial_setup_allowed%20%3E%20(property)%20type">Link to this property</a>

value: boolean

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20partial_setup_allowed%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)%20%3E%20(property)%20partial_setup_allowed">Link to this property</a>

</details>

[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/typescript/resources/tenants/subresources/memberships/methods/list)

client.tenants.memberships.list(stringtenantID, RequestOptionsoptions?): SinglePage< [TenantMembership](<https://developers.cloudflare.com/api/typescript/resources/tenants#(resource)%20tenants.memberships%20%3E%20(model)%20tenant_membership%20%3E%20(schema)>) {user\_email, user\_name, user\_tag } >

GET/tenants/{tenant\_id}/memberships

##### ModelsExpand Collapse

<details>

<summary>

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

</summary>

user\_email: string

<a href="#(resource)%20tenants.memberships%20%3E%20(model)%20tenant_membership%20%3E%20(schema)%20%3E%20(property)%20user_email">Link to this property</a>

user\_name: string

<a href="#(resource)%20tenants.memberships%20%3E%20(model)%20tenant_membership%20%3E%20(schema)%20%3E%20(property)%20user_name">Link to this property</a>

user\_tag: string

<a href="#(resource)%20tenants.memberships%20%3E%20(model)%20tenant_membership%20%3E%20(schema)%20%3E%20(property)%20user_tag">Link to this property</a>

</details>

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