## List organizations the user has access to

`client.organizations.list(OrganizationListParamsquery?, RequestOptionsoptions?): SinglePage<Organization>`

**get** `/organizations`

Retrieve a list of organizations a particular user has access to. (Currently in Public Beta - see https://developers.cloudflare.com/fundamentals/organizations/)

### Parameters

- `query: OrganizationListParams`

  - `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.

  - `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)."

      - `(string & {})`

      - `"null"`

        - `"null"`

### Returns

- `Organization`

  References an Organization in the Cloudflare data model.

  - `id: string`

  - `create_time: string`

  - `meta: Meta`

    - `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.

    - `managed_by?: string`

    - `tenant_flags?: TenantFlags`

      Enable features for Organizations.

      - `account_creation: string`

      - `account_deletion: string`

      - `account_migration: string`

      - `account_mobility: string`

      - `enterprise_capability: string`

      - `member_management: string`

      - `sub_org_creation: string`

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

### Example

```typescript
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // 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);
}
```

#### Response

```json
{
  "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": {
        "hierarchy_tags": [
          "string"
        ],
        "managed_by": "managed_by",
        "tenant_flags": {
          "account_creation": "account_creation",
          "account_deletion": "account_deletion",
          "account_migration": "account_migration",
          "account_mobility": "account_mobility",
          "enterprise_capability": "enterprise_capability",
          "member_management": "member_management",
          "sub_org_creation": "sub_org_creation"
        }
      },
      "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
}
```