---
title: Tenants
---

[Skip to content](#%5Ftop) 

[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](https://developers.cloudflare.com/api/typescript/resources/tenants/methods/get)

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

GET/tenants/{tenant\_id}

##### ModelsExpand Collapse 

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

cdate: string

formatdate-time

edate: string

formatdate-time

tenant\_contacts: TenantContacts { email, website } 

email?: string

website?: string

tenant\_labels: Array<string\>

tenant\_metadata: TenantMetadata { dns } 

dns?: DNS { ns\_pool } 

ns\_pool: NSPool { primary, secondary } 

primary?: string

secondary?: string

tenant\_name: string

tenant\_network: unknown

tenant\_status: string

tenant\_tag: string

tenant\_type: string

tenant\_units: Array<TenantUnit\>

unit\_memberships: Array<unknown\>

unit\_metadata: unknown

unit\_name: string

unit\_status: string

unit\_tag: string

customer\_id?: string

#### TenantsAccount Types

##### [Get tenant account types](https://developers.cloudflare.com/api/typescript/resources/tenants/subresources/account%5Ftypes/methods/list)

client.tenants.accountTypes.list(stringtenantID, RequestOptionsoptions?): SinglePage<[AccountTypeListResponse](https://developers.cloudflare.com/api/typescript/resources/tenants#%28resource%29%20tenants.account%5Ftypes%20%3E%20%28model%29%20account%5Ftype%5Flist%5Fresponse%20%3E%20%28schema%29)\>

GET/tenants/{tenant\_id}/account\_types

##### ModelsExpand Collapse 

AccountTypeListResponse \= string

#### 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#%28resource%29%20tenants.accounts%20%3E%20%28model%29%20tenant%5Faccount%20%3E%20%28schema%29) { id, created\_on, name, 3 more } \>

GET/tenants/{tenant\_id}/accounts

##### ModelsExpand Collapse 

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

id: string

created\_on: string

formatdate-time

name: string | null

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

abuse\_contact\_email: string | null

access\_approval\_expiry: string | null

formatdate-time

api\_access\_enabled: boolean | null

Deprecateddefault\_nameservers: string | null

Use [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) instead. Deprecated.

enforce\_twofactor: boolean | null

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

Use [DNS Settings](https://developers.cloudflare.com/api/operations/dns-settings-for-an-account-list-dns-settings) instead. Deprecated.

type: "standard" | "enterprise"

One of the following:

"standard"

"enterprise"

tags?: Record<string, string\>

Account tags, present only when `include_tags=true` is requested.

#### 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#%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 } 

GET/tenants/{tenant\_id}/entitlements

##### ModelsExpand Collapse 

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

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

type: "bool"

value: boolean

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

type: "bool"

value: boolean

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

type: "bool"

value: boolean

custom\_entitlements: Array<CustomEntitlement\> | null

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

One of the following:

OrganizationsAPIMaxCountAllocation { type, value } 

type: "max\_count"

value: number

OrganizationsAPIBoolAllocation { type, value } 

type: "bool"

value: boolean

OrganizationsAPINullAllocation { type, value } 

type: ""

value?: unknown

feature: Feature { key } 

key: string

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

type: "max\_count"

value: number

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

type: "bool"

value: boolean

#### 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#%28resource%29%20tenants.memberships%20%3E%20%28model%29%20tenant%5Fmembership%20%3E%20%28schema%29) { user\_email, user\_name, user\_tag } \>

GET/tenants/{tenant\_id}/memberships

##### ModelsExpand Collapse 

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

user\_email: string

user\_name: string

user\_tag: string