Account Details

accounts.get() -> Account

GET/accounts/{account_id}

Get information about a specific account that you are a member of.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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

Accepted Permissions (at least one required)

Trust and Safety WriteTrust and Safety ReadDNS View WriteDNS View ReadSCIM ProvisioningLoad Balancers Account WriteLoad Balancers Account ReadZero Trust: PII ReadDDoS Botnet Feed WriteDDoS Botnet Feed ReadWorkers R2 Storage WriteWorkers R2 Storage ReadDDoS Protection WriteDDoS Protection ReadWorkers Tail ReadWorkers KV Storage WriteWorkers KV Storage ReadWorkers Scripts WriteWorkers Scripts ReadLoad Balancing: Monitors and Pools WriteLoad Balancing: Monitors and Pools ReadAccount Firewall Access Rules WriteAccount Firewall Access Rules ReadDNS Firewall WriteDNS Firewall ReadBilling WriteBilling ReadAccount Settings WriteAccount Settings Read

ParametersExpand Collapse

account_id: str

Account identifier tag.

maxLength32

minLength32

ReturnsExpand Collapse

class Account: …

id: str

Identifier

maxLength32

minLength32

name: str

Account name

type: Literal["standard", "enterprise"]

One of the following:

"standard"

"enterprise"

created_on: Optional[datetime]

Timestamp for the creation of the account

formatdate-time

legacy_flags: Optional[LegacyFlags]

Legacy account flags.

enterprise_zone_quota: Optional[LegacyFlagsEnterpriseZoneQuota]

Enterprise zone quota for standard and enterprise accounts. Accounts without a quota have a maximum of 0.

available: Optional[int]

Number of additional Enterprise zones available. Returns 0 if the quota is not allocated or is exhausted.

current: Optional[int]

Current number of Enterprise zones.

maximum: Optional[int]

Maximum number of Enterprise zones allowed.

managed_by: Optional[ManagedBy]

Parent container details

parent_org_id: Optional[str]

ID of the parent Organization, if one exists

maxLength32

parent_org_name: Optional[str]

Name of the parent Organization, if one exists

root_org_id: Optional[str]

ID of the root Organization, if one exists

maxLength32

should_display_parent_orgs: Optional[bool]

Indicates whether the parent Organization hierarchy should be displayed

settings: Optional[Settings]

Account settings

abuse_contact_email: Optional[str]

Sets an abuse contact email to notify for abuse reports.

enforce_twofactor: Optional[bool]

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

Account Details

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
account = client.accounts.get(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(account.id)

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "Demo Account",
    "type": "standard",
    "created_on": "2014-03-01T12:21:02Z",
    "legacy_flags": {
      "enterprise_zone_quota": {
        "available": 168,
        "current": 82,
        "maximum": 250
      }
    },
    "managed_by": {
      "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
      "parent_org_name": "Demo Parent Organization",
      "root_org_id": "46f0a1ce86ec3d91fae00db3b8b48cee",
      "should_display_parent_orgs": true
    },
    "settings": {
      "abuse_contact_email": "abuse_contact_email",
      "enforce_twofactor": true
    }
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "name": "Demo Account",
    "type": "standard",
    "created_on": "2014-03-01T12:21:02Z",
    "legacy_flags": {
      "enterprise_zone_quota": {
        "available": 168,
        "current": 82,
        "maximum": 250
      }
    },
    "managed_by": {
      "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
      "parent_org_name": "Demo Parent Organization",
      "root_org_id": "46f0a1ce86ec3d91fae00db3b8b48cee",
      "should_display_parent_orgs": true
    },
    "settings": {
      "abuse_contact_email": "abuse_contact_email",
      "enforce_twofactor": true
    }
  }
}