---
title: Tenants
---

[Skip to content](#%5Ftop) 

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

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

GET/tenants/{tenant\_id}

##### ModelsExpand Collapse 

type Tenant struct{…}

Cdate Time

formatdate-time

Edate Time

formatdate-time

TenantContacts TenantTenantContacts

Email stringOptional

Website stringOptional

TenantLabels \[\]string

TenantMetadata TenantTenantMetadata

DNS TenantTenantMetadataDNSOptional

NSPool TenantTenantMetadataDNSNSPool

Primary stringOptional

Secondary stringOptional

TenantName string

TenantNetwork unknown

TenantStatus string

TenantTag string

TenantType string

TenantUnits \[\]TenantTenantUnit

UnitMemberships \[\]unknown

UnitMetadata unknown

UnitName string

UnitStatus string

UnitTag string

CustomerID stringOptional

#### TenantsAccount Types

##### [Get tenant account types](https://developers.cloudflare.com/api/go/resources/tenants/subresources/account%5Ftypes/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#%28resource%29%20tenants.accounts%20%3E%20%28model%29%20tenant%5Faccount%20%3E%20%28schema%29)\], error)

GET/tenants/{tenant\_id}/accounts

##### ModelsExpand Collapse 

type TenantAccount struct{…}

ID string

CreatedOn Time

formatdate-time

Name string

Settings TenantAccountSettings

AbuseContactEmail string

AccessApprovalExpiry Time

formatdate-time

APIAccessEnabled bool

DeprecatedDefaultNameservers string

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

EnforceTwofactor bool

DeprecatedUseAccountCustomNSByDefault bool

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

Type TenantAccountType

One of the following:

const TenantAccountTypeStandard TenantAccountType \= "standard"

const TenantAccountTypeEnterprise TenantAccountType \= "enterprise"

Tags map\[string, string\]Optional

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

#### 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#%28resource%29%20tenants.entitlements%20%3E%20%28model%29%20tenant%5Fentitlements%20%3E%20%28schema%29), error)

GET/tenants/{tenant\_id}/entitlements

##### ModelsExpand Collapse 

type TenantEntitlements struct{…}

AllowAddSubdomain TenantEntitlementsAllowAddSubdomain

Type TenantEntitlementsAllowAddSubdomainType

Value bool

AllowAutoAcceptInvites TenantEntitlementsAllowAutoAcceptInvites

Type TenantEntitlementsAllowAutoAcceptInvitesType

Value bool

CNAMESetupAllowed TenantEntitlementsCNAMESetupAllowed

Type TenantEntitlementsCNAMESetupAllowedType

Value bool

CustomEntitlements \[\]TenantEntitlementsCustomEntitlement

Allocation TenantEntitlementsCustomEntitlementsAllocation

One of the following:

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIMaxCountAllocationType

Value int64

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPIBoolAllocationType

Value bool

type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocation struct{…}

Type TenantEntitlementsCustomEntitlementsAllocationOrganizationsAPINullAllocationType

Value unknownOptional

Feature TenantEntitlementsCustomEntitlementsFeature

Key string

MhsCertificateCount TenantEntitlementsMhsCertificateCount

Type TenantEntitlementsMhsCertificateCountType

Value int64

PartialSetupAllowed TenantEntitlementsPartialSetupAllowed

Type TenantEntitlementsPartialSetupAllowedType

Value bool

#### 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#%28resource%29%20tenants.memberships%20%3E%20%28model%29%20tenant%5Fmembership%20%3E%20%28schema%29)\], error)

GET/tenants/{tenant\_id}/memberships

##### ModelsExpand Collapse 

type TenantMembership struct{…}

UserEmail string

UserName string

UserTag string