API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Organizations

List organizations the user has access to

client.organizations.list(OrganizationListParams { id, containing, name, 3 more } query?, RequestOptionsoptions?): SinglePage<Organization { id, create_time, meta, 3 more } >

GET/organizations

Get organization

client.organizations.get(stringorganizationId, RequestOptionsoptions?): Organization { id, create_time, meta, 3 more }

GET/organizations/{organization_id}

Create organization

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

POST/organizations

Modify organization.

client.organizations.update(stringorganizationId, OrganizationUpdateParams { name, parent, profile } body, RequestOptionsoptions?): Organization { id, create_time, meta, 3 more }

PUT/organizations/{organization_id}

Delete organization.

client.organizations.delete(stringorganizationId, RequestOptionsoptions?): OrganizationDeleteResponse { id }

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: 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

OrganizationDeleteResponse { id }

id: string

OrganizationsOrganization Accounts

OrganizationsOrganization Profile

Get organization profile

client.organizations.organizationProfile.get(stringorganizationId, RequestOptionsoptions?): Result { business_address, business_email, business_name, 2 more }

GET/organizations/{organization_id}/profile

Modify organization profile.

client.organizations.organizationProfile.update(stringorganizationId, OrganizationProfileUpdateParams { business_address, business_email, business_name, 2 more } body, RequestOptionsoptions?): void

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