Skip to content
Cloudflare API
Start here
API Reference
Organizations

Create organization

client.organizations.create(OrganizationCreateParams { name, parent, profile } body, RequestOptionsoptions?): Organization { id, create_time, meta, 3 more }
POST/organizations

Create a new organization for a user. (Currently in Closed Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

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
Accepted Permissions (at least one required)
User Details Write
ParametersExpand Collapse
body: OrganizationCreateParams { name, parent, profile }
name: string
parent?: Parent
id: string
name: string
profile?: Profile
business_address: string
business_email: string
business_name: string
business_phone: string
external_metadata: string
ReturnsExpand Collapse
Organization { id, create_time, meta, 3 more }

References an Organization in the Cloudflare data model.

id: string
create_time: string
formatdate-time
meta: Meta { flags, managed_by }
flags?: Flags { 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?: string
name: string
parent?: Parent { id, name }
id: string
name: string
profile?: Profile { business_address, business_email, business_name, 2 more }
business_address: string
business_email: string
business_name: string
business_phone: string
external_metadata: string

Create organization

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted
  apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted
});

const organization = await client.organizations.create({ name: 'name' });

console.log(organization.id);
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "flags": {
        "account_creation": "account_creation",
        "account_deletion": "account_deletion",
        "account_migration": "account_migration",
        "account_mobility": "account_mobility",
        "sub_org_creation": "sub_org_creation"
      },
      "managed_by": "managed_by"
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "name": "name"
    },
    "profile": {
      "business_address": "business_address",
      "business_email": "business_email",
      "business_name": "business_name",
      "business_phone": "business_phone",
      "external_metadata": "external_metadata"
    }
  },
  "success": true
}
Returns Examples
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    "create_time": "2019-12-27T18:11:19.117Z",
    "meta": {
      "flags": {
        "account_creation": "account_creation",
        "account_deletion": "account_deletion",
        "account_migration": "account_migration",
        "account_mobility": "account_mobility",
        "sub_org_creation": "sub_org_creation"
      },
      "managed_by": "managed_by"
    },
    "name": "name",
    "parent": {
      "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "name": "name"
    },
    "profile": {
      "business_address": "business_address",
      "business_email": "business_email",
      "business_name": "business_name",
      "business_phone": "business_phone",
      "external_metadata": "external_metadata"
    }
  },
  "success": true
}