Organizations

List organizations the user has access to

GET/organizations

ModelsExpand Collapse

Organization object { id, create_time, meta, 3 more }

References an Organization in the Cloudflare data model.

id: string

create_time: string

formatdate-time

meta: object { hierarchy_tags, managed_by, tenant_flags }

hierarchy_tags: optional array of string

Ordered chain of organization tags from the root organization down to (and including) this organization itself. Root organizations return a single-element array containing their own tag; sub-organizations return [rootTag, ...intermediateTags, parentTag, selfTag]. Useful for constructing authorization scopes that need to cover every ancestor in the hierarchy.

managed_by: optional string

tenant_flags: optional object { account_creation, account_creation_applies_tenant_defaults, account_deletion, 5 more }

Enable features for Organizations.

account_creation: string

account_creation_applies_tenant_defaults: string

account_deletion: string

account_migration: string

account_mobility: string

enterprise_capability: string

member_management: string

sub_org_creation: string

parent: optional object { id, name }

id: string

profile: optional AccountProfile { business_address, business_email, business_name, 2 more }

OrganizationDeleteResponse object { id }

id: string

OrganizationsOrganization Accounts

List organization accounts

GET/organizations/{organization_id}/accounts

ModelsExpand Collapse

OrganizationAccounts object { id, name, type, 3 more }

id: string

Identifier

maxLength32

minLength32

Account name

maxLength100

type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

created_on: optional string

Timestamp for the creation of the account

formatdate-time

managed_by: optional object { parent_org_id, parent_org_name }

Parent container details

parent_org_id: optional string

ID of the parent Organization, if one exists

maxLength32

parent_org_name: optional string

Name of the parent Organization, if one exists

settings: optional object { abuse_contact_email, enforce_twofactor }

Account settings

abuse_contact_email: optional string

Sets an abuse contact email to notify for abuse reports.

enforce_twofactor: optional boolean

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

OrganizationAccountGetResponse = array of TenantAccount { id, created_on, name, 3 more }

id: string

created_on: string

formatdate-time

settings: object { abuse_contact_email, access_approval_expiry, api_access_enabled, 3 more }

abuse_contact_email: string

access_approval_expiry: string

formatdate-time

api_access_enabled: boolean

Deprecateddefault_nameservers: string

Use DNS Settings instead. Deprecated.

enforce_twofactor: boolean

Deprecateduse_account_custom_ns_by_default: boolean

Use DNS Settings instead. Deprecated.

type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

tags: optional map[string]

Account tags, present only when include_tags=true is requested.

OrganizationsOrganization Profile

Get organization profile

GET/organizations/{organization_id}/profile

Modify organization profile.

PUT/organizations/{organization_id}/profile

ModelsExpand Collapse

OrganizationProfile object { business_address, business_email, business_name, 2 more }

business_address: string

business_email: string

business_name: string

business_phone: string

external_metadata: string

OrganizationsMembers

List organization members

GET/organizations/{organization_id}/members

Get organization member

GET/organizations/{organization_id}/members/{member_id}

Create organization member

POST/organizations/{organization_id}/members

Delete organization member

DELETE/organizations/{organization_id}/members/{member_id}

ModelsExpand Collapse

OrganizationMember object { id, create_time, meta, 3 more }

id: string

Organization Member ID

create_time: string

formatdate-time

meta: map[unknown]

status: "active" or "pending" or "rejected" or "canceled"

One of the following:

"active"

"pending"

"rejected"

"canceled"

update_time: string

formatdate-time

user: object { id, email, name, two_factor_authentication_enabled }

id: string

email: string

two_factor_authentication_enabled: boolean

OrganizationsLogs

OrganizationsLogsAudit

Get organization audit logs (Version 2)

GET/organizations/{organization_id}/logs/audit

Get resource change history from an organization audit log entry (Version 2)

GET/organizations/{organization_id}/logs/audit/{id}/history

ModelsExpand Collapse

AuditListResponse object { id, action, actor, 3 more }

id: optional string

A unique identifier for the audit log entry.

maxLength32

action: optional object { description, result, time, type }

Provides information about the action performed.

description: optional string

A short description of the action performed.

result: optional string

The result of the action, indicating success or failure.

time: optional string

A timestamp indicating when the action was logged.

formatdate-time

type: optional string

A short string that describes the action that was performed.

actor: optional object { id, context, email, 4 more }

Provides details about the actor who performed the action.

id: optional string

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: optional "api" or "api_key" or "api_token" or 3 more

The context in which the action was initiated.

api: The action was performed through the API. The specific credential type was not recorded.
api_key: The action was authenticated with a Cloudflare Global API Key.
api_token: The action was authenticated with an API token.
dash: The action was performed through the Cloudflare dashboard.
oauth: The action was authenticated with an OAuth token.
origin_ca_key: The action was authenticated with an Origin CA key.

One of the following:

"api"

"api_key"

"api_token"

"dash"

"oauth"

"origin_ca_key"

email: optional string

The email of the actor who performed the action.

formatemail

ip_address: optional string

The IP address of the request that performed the action.

token_id: optional string

The API token ID when the actor context is an api_token or oauth.

token_name: optional string

The API token name when the actor context is an api_token or oauth.

type: optional "cloudflare_admin" or "system" or "user"

The type of actor.

One of the following:

"cloudflare_admin"

"system"

"user"

organization: optional object { id }

Contains organization related information.

id: optional string

A unique identifier for the organization.

raw: optional object { cf_ray_id, method, status_code, 2 more }

Provides raw information about the request and response.

cf_ray_id: optional string

The Cloudflare Ray ID for the request.

method: optional string

The HTTP method of the request.

status_code: optional number

The HTTP response status code returned by the API.

uri: optional string

The URI of the request.

user_agent: optional string

The client’s user agent string sent with the request.

resource: optional object { id, product, request, 3 more }

Provides details about the affected resource.

id: optional string

The unique identifier for the affected resource.

product: optional string

The Cloudflare product associated with the resource.

request: optional unknown

response: optional unknown

scope: optional unknown

The scope of the resource.

type: optional string

The type of the resource.

AuditHistoryResponse = array of object { id, action, actor, 3 more }

id: optional string

A unique identifier for the audit log entry.

maxLength32

action: optional object { description, result, time, type }

Provides information about the action performed.

description: optional string

A short description of the action performed.

result: optional string

The result of the action, indicating success or failure.

time: optional string

A timestamp indicating when the action was logged.

formatdate-time

type: optional string

A short string that describes the action that was performed.

actor: optional object { id, context, email, 4 more }

Provides details about the actor who performed the action.

id: optional string

The ID of the actor who performed the action. If a user performed the action, this will be their User ID.

context: optional "api" or "api_key" or "api_token" or 3 more

The context in which the action was initiated.

api: The action was performed through the API. The specific credential type was not recorded.
api_key: The action was authenticated with a Cloudflare Global API Key.
api_token: The action was authenticated with an API token.
dash: The action was performed through the Cloudflare dashboard.
oauth: The action was authenticated with an OAuth token.
origin_ca_key: The action was authenticated with an Origin CA key.

One of the following:

"api"

"api_key"

"api_token"

"dash"

"oauth"

"origin_ca_key"

email: optional string

The email of the actor who performed the action.

formatemail

ip_address: optional string

The IP address of the request that performed the action.

token_id: optional string

The API token ID when the actor context is an api_token or oauth.

token_name: optional string

The API token name when the actor context is an api_token or oauth.

type: optional "cloudflare_admin" or "system" or "user"

The type of actor.

One of the following:

"cloudflare_admin"

"system"

"user"

organization: optional object { id }

Contains organization related information.

id: optional string

A unique identifier for the organization.

raw: optional object { cf_ray_id, method, status_code, 2 more }

Provides raw information about the request and response.

cf_ray_id: optional string

The Cloudflare Ray ID for the request.

method: optional string

The HTTP method of the request.

status_code: optional number

The HTTP response status code returned by the API.

uri: optional string

The URI of the request.

user_agent: optional string

The client’s user agent string sent with the request.

resource: optional object { id, product, request, 3 more }

Provides details about the affected resource.

id: optional string

The unique identifier for the affected resource.

product: optional string

The Cloudflare product associated with the resource.

request: optional unknown

response: optional unknown

scope: optional unknown

The scope of the resource.

type: optional string

The type of the resource.

OrganizationsBilling

OrganizationsBillingUsage

Get Organization Usage (Version 2, Alpha, Restricted)

GET/organizations/{organization_id}/billable/usage

ModelsExpand Collapse

UsageGetResponse = array of object { ChargeCategory, ChargeDescription, ChargeFrequency, 33 more }

Contains the array of cost and usage records.

ChargeCategory: "Usage"

Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported.

ChargeDescription: string

Self-contained summary of the charge’s purpose and price.

ChargeFrequency: "Usage-Based"

Indicates how often a charge occurs. Currently only “Usage-Based” is supported.

ChargePeriodEnd: string

Exclusive end of the time interval during which the usage was consumed.

formatdate-time

ChargePeriodStart: string

Inclusive start of the time interval during which the usage was consumed.

formatdate-time

ConsumedQuantity: number

Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.

ConsumedUnit: string

Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”).

HostProviderName: string

Name of the entity providing the underlying infrastructure or platform.

InvoiceIssuerName: string

Name of the entity responsible for invoicing for the services consumed.

ServiceProviderName: string

Name of the entity that made the services available for purchase.

x_BillableMetricId: string

The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId.

BilledCost: optional number

A charge serving as the basis for invoicing, inclusive of all reduced rates and discounts while excluding the amortization of upfront charges (one-time or recurring).

BillingAccountId: optional string

Public identifier of the Cloudflare account (account tag). Omitted when account is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by account: that usage is returned as its own record with no account.

BillingAccountName: optional string

Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level.

BillingCurrency: optional string

Currency that a charge was billed in (ISO 4217).

BillingPeriodEnd: optional string

Exclusive end of the billing cycle that contains this usage record.

formatdate-time

BillingPeriodStart: optional string

Inclusive start of the billing cycle that contains this usage record.

formatdate-time

ChargeClass: optional "Correction"

Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period.

ContractedCost: optional number

Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.

ContractedUnitPrice: optional number

The agreed-upon unit price for a single PricingUnit of the associated billable metric, inclusive of negotiated discounts, if present, while excluding any other discounts.

EffectiveCost: optional number

The amortized cost of the charge after applying all reduced rates, discounts, and the applicable portion of relevant, prepaid purchases (one-time or recurring) that covered the charge.

ListCost: optional number

Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.

ListUnitPrice: optional number

Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts.

PricingQuantity: optional number

Volume of a given service used or purchased, based on the PricingUnit.

PricingUnit: optional string

Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.

RegionId: optional string

Provider-assigned identifier for an isolated geographic area where a service is provided.

RegionName: optional string

Name of an isolated geographic area where a service is provided.

SubAccountId: optional string

Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID.

SubAccountName: optional string

Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name.

Tags: optional map[string or true]

Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.

One of the following:

string

true

x_BillableMetricName: optional string

The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter.

x_ProductCategoryName: optional string

The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.

x_ProductFamilyId: optional string

The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.

x_ProductFamilyName: optional string

The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName.

x_ZoneId: optional string

The identifier for the Cloudflare zone (zone tag). Omitted when zone is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by zone. Cloudflare extension.

x_ZoneName: optional string

The display name of the Cloudflare zone. Omitted when zone is not part of the requested grouping, and for usage measured at contract level. Cloudflare extension.