Organizations

Manage Cloudflare organizations and their hierarchies

The Organizations API allows you to create, manage, and organize hierarchical structures for your Cloudflare resources. Organizations are currently in Closed Beta.

Create organization

Create a new organization for a user.

const organization = await client.organizations.create({
  name: 'Acme Corporation',
  profile: {
    business_name: 'Acme Corp',
    business_email: '[e-mail]',
    business_address: '123 Main St',
    business_phone: '[phone]',
    external_metadata: '{}'
  }
});

name · string · required

The name of the organization

parent · object

Parent organization reference

Show child attributes

id · string · required

Parent organization identifier

profile · object

Organization profile information

Show child attributes

business_name · string · required

Legal business name

business_email · string · required

Business contact email

business_address · string · required

Business address

business_phone · string · required

Business phone number

external_metadata · string · required

External metadata for the organization

id · string

Organization identifier

name · string

Organization name

create_time · string

ISO 8601 timestamp when the organization was created

meta · object

Organization metadata

Show child attributes

flags · object

Feature flags for the organization

managed_by · string

Entity managing the organization

parent · object

Parent organization details

Show child attributes

id · string

Parent organization ID

name · string

Parent organization name

profile · object

Organization profile information

Update organization

Modify an existing organization.

const organization = await client.organizations.update(
  'f1234567890abcdef1234567890abcde',
  {
    name: 'Acme Corporation Updated',
    profile: {
      business_name: 'Acme Corp',
      business_email: '[e-mail]',
      business_address: '456 Market St',
      business_phone: '[phone]',
      external_metadata: '{}'
    }
  }
);

List organizations

Retrieve a list of organizations a particular user has access to.

for await (const organization of client.organizations.list()) {
  console.log(organization.name);
}

id · string[]

Filter by organization IDs

name · object

Filter by organization name

Show child attributes

contains · string

Name contains this string (case-insensitive)

startsWith · string

Name starts with this string (case-insensitive)

endsWith · string

Name ends with this string (case-insensitive)

containing · object

Filter by contained resources

Show child attributes

account · string

Filter to organizations containing this account

organization · string

Filter to organizations containing this sub-organization

user · string

Filter to organizations containing this user

parent · object

Filter by parent organization

Show child attributes

id · string

Parent organization ID (use “null” for root organizations)

page_size · number

Number of items to return (default: 10)

page_token · string

Pagination token from previous response

Get organization

Retrieve the details of a specific organization.

const organization = await client.organizations.get(
  'f1234567890abcdef1234567890abcde'
);

Delete organization

Delete an organization. The organization must be empty (no sub-organizations, accounts, members, or users).

const result = await client.organizations.delete(
  'f1234567890abcdef1234567890abcde'
);

id · string

ID of the deleted organization