Skip to content
Cloudflare API
Start here
API Reference

Organizations

List organizations the user has access to
GET/organizations
Get organization
GET/organizations/{organization_id}
Create organization
POST/organizations
Modify organization.
PUT/organizations/{organization_id}
Delete organization.
DELETE/organizations/{organization_id}
ModelsExpand Collapse
Organization { id, create_time, meta, 3 more }

References an Organization in the Cloudflare data model.

id: string
create_time: string
formatdate-time
meta: { flags, managed_by }
flags: optional { account_creation, account_deletion, account_migration, 2 more }

Enable features for Organizations.

account_creation: string
account_deletion: string
account_migration: string
account_mobility: string
sub_org_creation: string
managed_by: optional string
name: string
parent: optional { id, name }
id: string
name: string
profile: optional AccountProfile { business_address, business_email, business_name, 2 more }
OrganizationDeleteResponse { id }
id: string

OrganizationsOrganization Accounts

Get organization accounts
GET/organizations/{organization_id}/accounts
ModelsExpand Collapse
OrganizationAccounts { id, name, type, 3 more }
id: string

Identifier

maxLength32
minLength32
name: string

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 { 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 { 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 { id, created_on, name, 2 more }
id: string
created_on: string
formatdate-time
name: string
settings: { 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"

OrganizationsOrganization Profile

Get organization profile
GET/organizations/{organization_id}/profile
Modify organization profile.
PUT/organizations/{organization_id}/profile
ModelsExpand Collapse
OrganizationProfile { 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 { id, create_time, meta, 3 more }
id: string

Organization Member ID

create_time: string
formatdate-time
meta: map[unknown]
status: "active" or "canceled"
One of the following:
"active"
"canceled"
update_time: string
formatdate-time
user: { id, email, name, two_factor_authentication_enabled }
id: string
email: string
name: string
two_factor_authentication_enabled: boolean