---
title: Get tenant details
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Tenants](https://developers.cloudflare.com/api/resources/tenants)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get tenant details
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`
##### P ath ParametersExpand Collapse
tenant\_id: 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
errors: array of unknown
[Link to this property](<#(resource)%20tenants%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20tenants%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: Tenant { cdate, edate, tenant\_contacts, 9 more }
cdate: string
formatdate-time
Link to this property
edate: string
formatdate-time
Link to this property
tenant\_contacts: object {email, website }
email: optional string
Link to this property
website: optional string
Link to this property
Link to this property
tenant\_labels: array of string
Link to this property
tenant\_metadata: object {dns }
dns: optional object {ns\_pool }
ns\_pool: object {primary, secondary }
primary: optional string
Link to this property
secondary: optional string
Link to this property
Link to this property
Link to this property
Link to this property
tenant\_name: string
Link to this property
tenant\_network: unknown
Link to this property
tenant\_status: string
Link to this property
tenant\_tag: string
Link to this property
tenant\_type: string
Link to this property
tenant\_units: array of object {unit\_memberships, unit\_metadata, unit\_name, 2 more }
unit\_memberships: array of unknown
Link to this property
unit\_metadata: unknown
Link to this property
unit\_name: string
Link to this property
unit\_status: string
Link to this property
unit\_tag: string
Link to this property
Link to this property
customer\_id: optional string
Link to this property
[Link to this property](<#(resource)%20tenants%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
[Link to this property](<#(resource)%20tenants%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Get tenant details
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/tenants/$TENANT_ID \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY"
```
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
}
```