List organizations the user has access to

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

GET/organizations

Retrieve a list of organizations a particular user has access to. (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 WriteUser Details Read

ParametersExpand Collapse

query: OrganizationListParams { id, containing, name, 3 more }

id?: Array<string>

Only return organizations with the specified IDs (ex. id=foo&id=bar). Send multiple elements by repeating the query value.

containing?: Containing

account?: string

Filter the list of organizations to the ones that contain this particular account.

organization?: string

Filter the list of organizations to the ones that contain this particular organization.

user?: string

Filter the list of organizations to the ones that contain this particular user.

IMPORTANT: Just because an organization "contains" a user is not a representation of any authorization or privilege to manage any resources therein. An organization "containing" a user simply means the user is managed by that organization.

name?: Name

contains?: string

(case-insensitive) Filter the list of organizations to where the name contains a particular string.

endsWith?: string

(case-insensitive) Filter the list of organizations to where the name ends with a particular string.

startsWith?: string

(case-insensitive) Filter the list of organizations to where the name starts with a particular string.

page_size?: number

The amount of items to return. Defaults to 10.

maximum1000

minimum0

page_token?: string

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

parent?: Parent

id?: (string & {}) | "null"

Filter the list of organizations to the ones that are a sub-organization of the specified organization.

"null" is a valid value to provide for this parameter. It means "where an organization has no parent (i.e. it is a 'root' organization)."

One of the following:

(string & {})

"null"

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

List organizations the user has access to

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
});

// Automatically fetches more pages as needed.
for await (const organization of client.organizations.list()) {
  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"
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "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"
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "success": true
}