Skip to content
Cloudflare API
Start here
API Reference
Tenants
Accounts

List tenant accounts

GET/tenants/{tenant_id}/accounts

Lists all Cloudflare accounts across this tenant’s hierarchy using the legacy Account response shape. Use GET /organizations/{organization_id}/accounts to list only accounts immediately attached to a specific Organization using the modern Account response shape. Use page_token and page_size for cursor pagination, or provide page and per_page together for legacy offset pagination. Cursor pagination takes precedence when requested.

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
Path ParametersExpand Collapse
tenant_id: string
Query ParametersExpand Collapse
account_pubname: optional object { contains, endsWith, startsWith }
contains: optional string

(case-insensitive) Filter the list of accounts to where the account_pubname contains a particular string.

endsWith: optional string

(case-insensitive) Filter the list of accounts to where the account_pubname ends with a particular string.

startsWith: optional string

(case-insensitive) Filter the list of accounts to where the account_pubname starts with a particular string.

direction: optional "asc" or "desc"

Sort direction for the order_by field. Valid values: asc, desc. Defaults to asc when order_by is specified.

One of the following:
"asc"
"desc"
include_total: optional boolean

Whether to calculate and return the exact result_info.total_size for cursor pagination. Defaults to true. When false, total_size is omitted. Legacy page/per_page requests always calculate total_count.

name: optional object { contains, endsWith, startsWith }
contains: optional string

(case-insensitive) Filter the list of accounts to where the name contains a particular string.

endsWith: optional string

(case-insensitive) Filter the list of accounts to where the name ends with a particular string.

startsWith: optional string

(case-insensitive) Filter the list of accounts to where the name starts with a particular string.

order_by: optional "account_name"

Field to order results by. Currently supported values: account_name.

page: optional number

Legacy offset page number. Must be provided with per_page. Values below 1 are treated as

  1. Cursor pagination takes precedence when requested.
page_size: optional number

The amount of items to return. Defaults to 10.

maximum1000
minimum0
page_token: optional string

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

per_page: optional number

Legacy offset page size. Must be provided with page. Values are clamped to the range 1-100. Cursor pagination takes precedence when requested.

status: optional "active" or "deleted"

Filter accounts by lifecycle status. Defaults to active.

One of the following:
"active"
"deleted"
ReturnsExpand Collapse
errors: array of unknown
messages: array of ResponseInfo { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
result: array of object { account_pubname, account_tag, account_type, 2 more }
account_pubname: string
account_tag: string
account_type: "standard" or "enterprise"
One of the following:
"standard"
"enterprise"
created_on: string
formatdate-time
settings: object { access_approval_expiry, api_access_enabled, enforce_two_factor, use_account_custom_ns_by_default }
access_approval_expiry: string
formatdate-time
api_access_enabled: boolean
enforce_two_factor: boolean
use_account_custom_ns_by_default: boolean
result_info: object { next_page_token, total_size } or object { count, page, per_page, total_count }
One of the following:
OrganizationsAPIPageTokenResultInfo object { next_page_token, total_size }
next_page_token: optional string

Use this opaque token in the next request to retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

total_size: optional number

Counts the total amount of items in a list with the applied filters. The API omits next_page_token to indicate no more items in a particular list.

OrganizationsAPILegacyPaginationResultInfo object { count, page, per_page, total_count }
count: number
page: number
per_page: number
total_count: number
success: true

List tenant accounts

curl https://api.cloudflare.com/client/v4/tenants/$TENANT_ID/accounts \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "account_pubname": "account_pubname",
      "account_tag": "account_tag",
      "account_type": "standard",
      "created_on": "2019-12-27T18:11:19.117Z",
      "settings": {
        "access_approval_expiry": "2019-12-27T18:11:19.117Z",
        "api_access_enabled": true,
        "enforce_two_factor": true,
        "use_account_custom_ns_by_default": true
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "success": true
}
Returns Examples
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "account_pubname": "account_pubname",
      "account_tag": "account_tag",
      "account_type": "standard",
      "created_on": "2019-12-27T18:11:19.117Z",
      "settings": {
        "access_approval_expiry": "2019-12-27T18:11:19.117Z",
        "api_access_enabled": true,
        "enforce_two_factor": true,
        "use_account_custom_ns_by_default": true
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "success": true
}