---
title: Get tenant details
---

[Skip to content](#_top)

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

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

Copy Markdown

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

---

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

# Get tenant details

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}

Retrieves a tenant’s identity, status, metadata, contacts, and organizational units.

##### 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%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20tenant_id%20%3E%20(schema)>)

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

### Get tenant details

TypeScript

HTTPTypeScriptPythonGoTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const tenant = await client.tenants.get('tenant_id');

console.log(tenant.customer_id);
```

200 example

```
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "cdate": "2019-12-27T18:11:19.117Z",
    "edate": "2019-12-27T18:11:19.117Z",
    "tenant_contacts": {
      "email": "email",
      "website": "website"
    },
    "tenant_labels": [
      "string"
    ],
    "tenant_metadata": {
      "dns": {
        "ns_pool": {
          "primary": "primary",
          "secondary": "secondary"
        }
      }
    },
    "tenant_name": "tenant_name",
    "tenant_network": {},
    "tenant_status": "tenant_status",
    "tenant_tag": "tenant_tag",
    "tenant_type": "tenant_type",
    "tenant_units": [
      {
        "unit_memberships": [
          {}
        ],
        "unit_metadata": {},
        "unit_name": "unit_name",
        "unit_status": "unit_status",
        "unit_tag": "unit_tag"
      }
    ],
    "customer_id": "customer_id"
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "cdate": "2019-12-27T18:11:19.117Z",
    "edate": "2019-12-27T18:11:19.117Z",
    "tenant_contacts": {
      "email": "email",
      "website": "website"
    },
    "tenant_labels": [
      "string"
    ],
    "tenant_metadata": {
      "dns": {
        "ns_pool": {
          "primary": "primary",
          "secondary": "secondary"
        }
      }
    },
    "tenant_name": "tenant_name",
    "tenant_network": {},
    "tenant_status": "tenant_status",
    "tenant_tag": "tenant_tag",
    "tenant_type": "tenant_type",
    "tenant_units": [
      {
        "unit_memberships": [
          {}
        ],
        "unit_metadata": {},
        "unit_name": "unit_name",
        "unit_status": "unit_status",
        "unit_tag": "unit_tag"
      }
    ],
    "customer_id": "customer_id"
  },
  "success": true
}
```