## List Memberships

`client.memberships.list(MembershipListParamsquery?, RequestOptionsoptions?): V4PagePaginationArray<Membership>`

**get** `/memberships`

List memberships of accounts the user can access.

### Parameters

- `query: MembershipListParams`

  - `account?: Account`

    - `name?: string`

      Account name

  - `direction?: "asc" | "desc"`

    Direction to order memberships.

    - `"asc"`

    - `"desc"`

  - `name?: string`

    Account name

  - `order?: "id" | "account.name" | "status"`

    Field to order memberships by.

    - `"id"`

    - `"account.name"`

    - `"status"`

  - `page?: number`

    Page number of paginated results.

  - `per_page?: number`

    Number of memberships per page.

  - `status?: "accepted" | "pending" | "rejected"`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Returns

- `Membership`

  - `id?: string`

    Membership identifier tag.

  - `account?: Account`

    - `id: string`

      Identifier

    - `name: string`

      Account name

    - `type: "standard" | "enterprise"`

      - `"standard"`

      - `"enterprise"`

    - `created_on?: string`

      Timestamp for the creation of the account

    - `managed_by?: ManagedBy`

      Parent container details

      - `parent_org_id?: string`

        ID of the parent Organization, if one exists

      - `parent_org_name?: string`

        Name of the parent Organization, if one exists

    - `settings?: Settings`

      Account settings

      - `abuse_contact_email?: string`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor?: boolean`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled?: boolean | null`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions?: Permissions`

    All access permissions for the user at the account.

    - `analytics?: PermissionGrant`

      - `read?: boolean`

      - `write?: boolean`

    - `billing?: PermissionGrant`

    - `cache_purge?: PermissionGrant`

    - `dns?: PermissionGrant`

    - `dns_records?: PermissionGrant`

    - `lb?: PermissionGrant`

    - `logs?: PermissionGrant`

    - `organization?: PermissionGrant`

    - `ssl?: PermissionGrant`

    - `waf?: PermissionGrant`

    - `zone_settings?: PermissionGrant`

    - `zones?: PermissionGrant`

  - `roles?: Array<string>`

    List of role names the membership has for this account.

  - `status?: "accepted" | "pending" | "rejected"`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Example

```node
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 membership of client.memberships.list()) {
  console.log(membership.id);
}
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "4536bcfad5faccb111b47003c79917fa",
      "account": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "Demo Account",
        "type": "standard",
        "created_on": "2014-03-01T12:21:02.0000Z",
        "managed_by": {
          "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
          "parent_org_name": "Demo Parent Organization"
        },
        "settings": {
          "abuse_contact_email": "abuse_contact_email",
          "enforce_twofactor": true
        }
      },
      "api_access_enabled": true,
      "permissions": {
        "analytics": {
          "read": true,
          "write": false
        },
        "billing": {
          "read": true,
          "write": false
        },
        "cache_purge": {
          "read": true,
          "write": false
        },
        "dns": {
          "read": true,
          "write": false
        },
        "dns_records": {
          "read": true,
          "write": false
        },
        "lb": {
          "read": true,
          "write": false
        },
        "logs": {
          "read": true,
          "write": false
        },
        "organization": {
          "read": true,
          "write": false
        },
        "ssl": {
          "read": true,
          "write": false
        },
        "waf": {
          "read": true,
          "write": false
        },
        "zone_settings": {
          "read": true,
          "write": false
        },
        "zones": {
          "read": true,
          "write": true
        }
      },
      "roles": [
        "Account Administrator"
      ],
      "status": "accepted"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```