---
title: List tenant entitlements
---

[Skip to content](#_top)

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

[Tenants](https://developers.cloudflare.com/api/go/resources/tenants)

[Entitlements](https://developers.cloudflare.com/api/go/resources/tenants/subresources/entitlements)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# List tenant entitlements

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

Retrieves the innate and custom entitlement allocations available to this tenant.

##### Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### ParametersExpand Collapse

tenantID string

[Link to this property](<#(resource)%20tenants.entitlements%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20tenant_id%20%3E%20(schema)>)

##### ReturnsExpand 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)>)

### List tenant entitlements

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  tenantEntitlements, err := client.Tenants.Entitlements.Get(context.TODO(), "tenant_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", tenantEntitlements.AllowAddSubdomain)
}
```

200 example

```
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "allow_add_subdomain": {
      "type": "bool",
      "value": true
    },
    "allow_auto_accept_invites": {
      "type": "bool",
      "value": true
    },
    "cname_setup_allowed": {
      "type": "bool",
      "value": true
    },
    "custom_entitlements": [
      {
        "allocation": {
          "type": "max_count",
          "value": 0
        },
        "feature": {
          "key": "key"
        }
      }
    ],
    "mhs_certificate_count": {
      "type": "max_count",
      "value": 0
    },
    "partial_setup_allowed": {
      "type": "bool",
      "value": true
    }
  },
  "success": true
}
```