---
title: Tenants
---

[Skip to content](#_top)

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

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

client.Tenants.Get(ctx, tenantID) (\*[Tenant](<https://developers.cloudflare.com/api/go/resources/tenants#(resource)%20tenants%20%3E%20(model)%20tenant%20%3E%20(schema)>), error)

GET/tenants/{tenant\_id}

##### ModelsExpand Collapse

<details>

<summary>

type Tenant struct{…}

</summary>

Cdate Time

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 Time

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>

TenantContacts TenantTenantContacts

</summary>

Email stringOptional

<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 stringOptional

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

TenantLabels \[]string

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

TenantMetadata TenantTenantMetadata

</summary>

<details>

<summary>

DNS TenantTenantMetadataDNSOptional

</summary>

<details>

<summary>

NSPool TenantTenantMetadataDNSNSPool

</summary>

Primary stringOptional

<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 stringOptional

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

TenantName 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>

TenantNetwork 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>

TenantStatus 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>

TenantTag 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>

TenantType 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>

TenantUnits \[]TenantTenantUnit

</summary>

UnitMemberships \[]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_memberships">Link to this property</a>

UnitMetadata 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>

UnitName 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>

UnitStatus 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>

UnitTag 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>

CustomerID stringOptional

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

client.Tenants.AccountTypes.List(ctx, tenantID) (\*SinglePage\[string], error)

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

#### TenantsAccounts

##### [List tenant accounts](https://developers.cloudflare.com/api/go/resources/tenants/subresources/accounts/methods/list)

client.Tenants.Accounts.List(ctx, tenantID) (\*SinglePage\[[TenantAccount](<https://developers.cloudflare.com/api/go/resources/tenants#(resource)%20tenants.accounts%20%3E%20(model)%20tenant_account%20%3E%20(schema)>)], error)

GET/tenants/{tenant\_id}/accounts

##### ModelsExpand Collapse

<details>

<summary>

type TenantAccount struct{…}

</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>

CreatedOn Time

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

<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 TenantAccountSettings

</summary>

AbuseContactEmail string

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

AccessApprovalExpiry Time

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>

APIAccessEnabled bool

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

DeprecatedDefaultNameservers string

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>

EnforceTwofactor bool

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

DeprecatedUseAccountCustomNSByDefault bool

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 TenantAccountType

</summary>

One of the following:

const TenantAccountTypeStandard TenantAccountType = "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>

const TenantAccountTypeEnterprise TenantAccountType = "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 map\[string, string]Optional

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

client.Tenants.Entitlements.Get(ctx, tenantID) (\*[TenantEntitlements](<https://developers.cloudflare.com/api/go/resources/tenants#(resource)%20tenants.entitlements%20%3E%20(model)%20tenant_entitlements%20%3E%20(schema)>), error)

GET/tenants/{tenant\_id}/entitlements

##### ModelsExpand Collapse

<details>

<summary>

type TenantEntitlements struct{…}

</summary>

<details>

<summary>

AllowAddSubdomain TenantEntitlementsAllowAddSubdomain

</summary>

Type TenantEntitlementsAllowAddSubdomainType

<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 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)%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>

AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites

</summary>

Type TenantEntitlementsAllowAutoAcceptInvitesType

<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 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)%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>

CNAMESetupAllowed TenantEntitlementsCNAMESetupAllowed

</summary>

Type TenantEntitlementsCNAMESetupAllowedType

<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 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)%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>

CustomEntitlements \[]TenantEntitlementsCustomEntitlement

</summary>

<details>

<summary>

Allocation TenantEntitlementsCustomEntitlementsAllocation

</summary>

One of the following:

<details>

<summary>

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct{…}

</summary>

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType

<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 int64

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

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct{…}

</summary>

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType

<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 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)%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>

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct{…}

</summary>

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType

<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 unknownOptional

<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 TenantEntitlementsCustomEntitlementsFeature

</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>

MhsCertificateCount TenantEntitlementsMhsCertificateCount

</summary>

Type TenantEntitlementsMhsCertificateCountType

<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 int64

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

PartialSetupAllowed TenantEntitlementsPartialSetupAllowed

</summary>

Type TenantEntitlementsPartialSetupAllowedType

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

client.Tenants.Memberships.List(ctx, tenantID) (\*SinglePage\[[TenantMembership](<https://developers.cloudflare.com/api/go/resources/tenants#(resource)%20tenants.memberships%20%3E%20(model)%20tenant_membership%20%3E%20(schema)>)], error)

GET/tenants/{tenant\_id}/memberships

##### ModelsExpand Collapse

<details>

<summary>

type TenantMembership struct{…}

</summary>

UserEmail 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>

UserName 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>

UserTag 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)>)