--- title: Organizations --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Organizations ##### [List organizations the user has access to](https://developers.cloudflare.com/api/typescript/resources/organizations/methods/list) client.organizations.list(OrganizationListParams {id, containing, name, 3 more } query?, RequestOptionsoptions?): SinglePage< [Organization]() {id, create\_time, meta, 3 more } > GET/organizations ##### [Get organization](https://developers.cloudflare.com/api/typescript/resources/organizations/methods/get) client.organizations.get(stringorganizationID, RequestOptionsoptions?): [Organization]() {id, create\_time, meta, 3 more } GET/organizations/{organization\_id} ##### [Create organization](https://developers.cloudflare.com/api/typescript/resources/organizations/methods/create) client.organizations.create(OrganizationCreateParams {name, parent, profile } body, RequestOptionsoptions?): [Organization]() {id, create\_time, meta, 3 more } POST/organizations ##### [Update organization](https://developers.cloudflare.com/api/typescript/resources/organizations/methods/update) client.organizations.update(stringorganizationID, OrganizationUpdateParams {name, parent, profile } body, RequestOptionsoptions?): [Organization]() {id, create\_time, meta, 3 more } PUT/organizations/{organization\_id} ##### [Delete organization](https://developers.cloudflare.com/api/typescript/resources/organizations/methods/delete) 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 Link to this property create\_time: string formatdate-time Link to this property
meta: Meta {hierarchy\_tags, managed\_by, tenant\_flags } hierarchy\_tags?: Array<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. Link to this property managed\_by?: string Link to this property
tenant\_flags?: TenantFlags {account\_creation, account\_creation\_applies\_tenant\_defaults, account\_deletion, 5 more } Enable features for Organizations. account\_creation: string Link to this property account\_creation\_applies\_tenant\_defaults: string Link to this property account\_deletion: string Link to this property account\_migration: string Link to this property account\_mobility: string Link to this property enterprise\_capability: string Link to this property member\_management: string Link to this property sub\_org\_creation: string Link to this property
Link to this property
Link to this property name: string Link to this property
parent?: Parent {id, name } id: string Link to this property name: string Link to this property
Link to this property
profile?: Profile {business\_address, business\_email, business\_name, 2 more } business\_address: string Link to this property business\_email: string Link to this property business\_name: string Link to this property business\_phone: string Link to this property external\_metadata: string Link to this property
Link to this property
[Link to this property](<#(resource)%20organizations%20%3E%20(model)%20organization%20%3E%20(schema)>)
OrganizationDeleteResponse {id } id: string Link to this property
[Link to this property](<#(resource)%20organizations%20%3E%20(model)%20organization_delete_response%20%3E%20(schema)>) #### OrganizationsOrganization Accounts #### OrganizationsOrganization Profile ##### [Get organization profile](https://developers.cloudflare.com/api/typescript/resources/organizations/subresources/organization_profile/methods/get) client.organizations.organizationProfile.get(stringorganizationID, RequestOptionsoptions?): Result {business\_address, business\_email, business\_name, 2 more } GET/organizations/{organization\_id}/profile ##### [Modify organization profile.](https://developers.cloudflare.com/api/typescript/resources/organizations/subresources/organization_profile/methods/update) 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 Link to this property business\_email: string Link to this property business\_name: string Link to this property business\_phone: string Link to this property external\_metadata: string Link to this property
[Link to this property](<#(resource)%20organizations.organization_profile%20%3E%20(model)%20organization_profile%20%3E%20(schema)>) #### OrganizationsMembers #### OrganizationsLogs #### OrganizationsLogsAudit ##### [Get organization audit logs (Version 2)](https://developers.cloudflare.com/api/typescript/resources/organizations/subresources/logs/subresources/audit/methods/list) client.organizations.logs.audit.list(stringorganizationID, AuditListParams {before, since, id, 20 more } query, RequestOptionsoptions?): CursorPaginationAfter< [AuditListResponse]() {id, action, actor, 3 more } > GET/organizations/{organization\_id}/logs/audit ##### [Get resource change history from an organization audit log entry (Version 2)](https://developers.cloudflare.com/api/typescript/resources/organizations/subresources/logs/subresources/audit/methods/history) client.organizations.logs.audit.history(stringid, AuditHistoryParams {organization\_id, action\_time, before, 4 more } params, RequestOptionsoptions?): [AuditHistoryResponse]() {id, action, actor, 3 more } GET/organizations/{organization\_id}/logs/audit/{id}/history ##### ModelsExpand Collapse
AuditListResponse {id, action, actor, 3 more } id?: string A unique identifier for the audit log entry. maxLength32 Link to this property
action?: Action {description, result, time, type } Provides information about the action performed. description?: string A short description of the action performed. Link to this property result?: string The result of the action, indicating success or failure. Link to this property time?: string A timestamp indicating when the action was logged. formatdate-time Link to this property type?: string A short string that describes the action that was performed. Link to this property
Link to this property
actor?: Actor {id, context, email, 4 more } Provides details about the actor who performed the action. id?: string The ID of the actor who performed the action. If a user performed the action, this will be their User ID. Link to this property
context?: "api"| "api\_key"| "api\_token"| 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" Link to this property "api\_key" Link to this property "api\_token" Link to this property "dash" Link to this property "oauth" Link to this property "origin\_ca\_key" Link to this property
Link to this property email?: string The email of the actor who performed the action. formatemail Link to this property ip\_address?: string The IP address of the request that performed the action. Link to this property token\_id?: string The API token ID when the actor context is an api\_token or oauth. Link to this property token\_name?: string The API token name when the actor context is an api\_token or oauth. Link to this property
type?: "cloudflare\_admin"| "system"| "user" The type of actor. One of the following: "cloudflare\_admin" Link to this property "system" Link to this property "user" Link to this property
Link to this property
Link to this property
organization?: Organization {id } Contains organization related information. id?: string A unique identifier for the organization. Link to this property
Link to this property
raw?: Raw {cf\_ray\_id, method, status\_code, 2 more } Provides raw information about the request and response. cf\_ray\_id?: string The Cloudflare Ray ID for the request. Link to this property method?: string The HTTP method of the request. Link to this property status\_code?: number The HTTP response status code returned by the API. Link to this property uri?: string The URI of the request. Link to this property user\_agent?: string The client’s user agent string sent with the request. Link to this property
Link to this property
resource?: Resource {id, product, request, 3 more } Provides details about the affected resource. id?: string The unique identifier for the affected resource. Link to this property product?: string The Cloudflare product associated with the resource. Link to this property request?: unknown Link to this property response?: unknown Link to this property scope?: unknown The scope of the resource. Link to this property type?: string The type of the resource. Link to this property
Link to this property
[Link to this property](<#(resource)%20organizations.logs.audit%20%3E%20(model)%20audit_list_response%20%3E%20(schema)>)
AuditHistoryResponse = Array<AuditHistoryResponseItem> id?: string A unique identifier for the audit log entry. maxLength32 Link to this property
action?: Action {description, result, time, type } Provides information about the action performed. description?: string A short description of the action performed. Link to this property result?: string The result of the action, indicating success or failure. Link to this property time?: string A timestamp indicating when the action was logged. formatdate-time Link to this property type?: string A short string that describes the action that was performed. Link to this property
Link to this property
actor?: Actor {id, context, email, 4 more } Provides details about the actor who performed the action. id?: string The ID of the actor who performed the action. If a user performed the action, this will be their User ID. Link to this property
context?: "api"| "api\_key"| "api\_token"| 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" Link to this property "api\_key" Link to this property "api\_token" Link to this property "dash" Link to this property "oauth" Link to this property "origin\_ca\_key" Link to this property
Link to this property email?: string The email of the actor who performed the action. formatemail Link to this property ip\_address?: string The IP address of the request that performed the action. Link to this property token\_id?: string The API token ID when the actor context is an api\_token or oauth. Link to this property token\_name?: string The API token name when the actor context is an api\_token or oauth. Link to this property
type?: "cloudflare\_admin"| "system"| "user" The type of actor. One of the following: "cloudflare\_admin" Link to this property "system" Link to this property "user" Link to this property
Link to this property
Link to this property
organization?: Organization {id } Contains organization related information. id?: string A unique identifier for the organization. Link to this property
Link to this property
raw?: Raw {cf\_ray\_id, method, status\_code, 2 more } Provides raw information about the request and response. cf\_ray\_id?: string The Cloudflare Ray ID for the request. Link to this property method?: string The HTTP method of the request. Link to this property status\_code?: number The HTTP response status code returned by the API. Link to this property uri?: string The URI of the request. Link to this property user\_agent?: string The client’s user agent string sent with the request. Link to this property
Link to this property
resource?: Resource {id, product, request, 3 more } Provides details about the affected resource. id?: string The unique identifier for the affected resource. Link to this property product?: string The Cloudflare product associated with the resource. Link to this property request?: unknown Link to this property response?: unknown Link to this property scope?: unknown The scope of the resource. Link to this property type?: string The type of the resource. Link to this property
Link to this property
[Link to this property](<#(resource)%20organizations.logs.audit%20%3E%20(model)%20audit_history_response%20%3E%20(schema)>) #### OrganizationsBilling #### OrganizationsBillingUsage ##### [Get Organization Usage (Version 2, Alpha, Restricted)](https://developers.cloudflare.com/api/typescript/resources/organizations/subresources/billing/subresources/usage/methods/get) client.organizations.billing.usage.get(stringorganizationID, UsageGetParams {from, to } query?, RequestOptionsoptions?): [UsageGetResponse]() {ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } GET/organizations/{organization\_id}/billable/usage ##### ModelsExpand Collapse
UsageGetResponse = Array<UsageGetResponseItem> 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. Link to this property ChargeDescription: string Self-contained summary of the charge’s purpose and price. Link to this property ChargeFrequency: "Usage-Based" Indicates how often a charge occurs. Currently only “Usage-Based” is supported. Link to this property ChargePeriodEnd: string Exclusive end of the time interval during which the usage was consumed. formatdate-time Link to this property ChargePeriodStart: string Inclusive start of the time interval during which the usage was consumed. formatdate-time Link to this property ConsumedQuantity: number Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations. Link to this property ConsumedUnit: string Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”). Link to this property HostProviderName: string Name of the entity providing the underlying infrastructure or platform. Link to this property InvoiceIssuerName: string Name of the entity responsible for invoicing for the services consumed. Link to this property ServiceProviderName: string Name of the entity that made the services available for purchase. Link to this property x\_BillableMetricId: string The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId. Link to this property BilledCost?: number| null 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). Link to this property BillingAccountId?: 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. Link to this property BillingAccountName?: string Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level. Link to this property BillingCurrency?: string| null Currency that a charge was billed in (ISO 4217). Link to this property BillingPeriodEnd?: string| null Exclusive end of the billing cycle that contains this usage record. formatdate-time Link to this property BillingPeriodStart?: string| null Inclusive start of the billing cycle that contains this usage record. formatdate-time Link to this property ChargeClass?: "Correction"| null Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. Link to this property ContractedCost?: number| null Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. Link to this property ContractedUnitPrice?: number| null 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. Link to this property EffectiveCost?: number| null 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. Link to this property ListCost?: number| null Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. Link to this property ListUnitPrice?: number| null Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. Link to this property PricingQuantity?: number| null Volume of a given service used or purchased, based on the PricingUnit. Link to this property PricingUnit?: string| null Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing. Link to this property RegionId?: string| null Provider-assigned identifier for an isolated geographic area where a service is provided. Link to this property RegionName?: string| null Name of an isolated geographic area where a service is provided. Link to this property SubAccountId?: string Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. Link to this property SubAccountName?: string Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. Link to this property
Tags?: Record<string, string| 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 Link to this property
true true Link to this property
Link to this property
Link to this property x\_BillableMetricName?: string The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter. Link to this property x\_ProductCategoryName?: string The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory. Link to this property x\_ProductFamilyId?: string The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId. Link to this property x\_ProductFamilyName?: string The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName. Link to this property x\_ZoneId?: string| null 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. Link to this property x\_ZoneName?: string| null 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. Link to this property
[Link to this property](<#(resource)%20organizations.billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)>)