API Reference

Memberships

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Memberships

client.memberships.list(MembershipListParams { account, direction, name, 4 more } query?, RequestOptionsoptions?): V4PagePaginationArray<Membership { id, account, api_access_enabled, 3 more } >

GET/memberships

List memberships of accounts the user can access.

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)

Memberships WriteMemberships Read

ParametersExpand Collapse

query: MembershipListParams { account, direction, name, 4 more }

account?: Account

name?: string

Account name

maxLength100

direction?: "asc" | "desc"

Direction to order memberships.

One of the following:

"asc"

"desc"

name?: string

Account name

maxLength100

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

Field to order memberships by.

One of the following:

"id"

"account.name"

"status"

page?: number

Page number of paginated results.

minimum1

per_page?: number

Number of memberships per page.

maximum50

minimum5

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

Status of this membership.

One of the following:

"accepted"

"pending"

"rejected"

ReturnsExpand Collapse

Membership { id, account, api_access_enabled, 3 more }

id?: string

Membership identifier tag.

maxLength32

account?: Account { id, name, type, 3 more }

id: string

Identifier

maxLength32

minLength32

name: string

Account name

maxLength100

type: "standard" | "enterprise"

One of the following:

"standard"

"enterprise"

created_on?: string

Timestamp for the creation of the account

formatdate-time

managed_by?: ManagedBy { parent_org_id, parent_org_name }

Parent container details

parent_org_id?: string

ID of the parent Organization, if one exists

maxLength32

parent_org_name?: string

Name of the parent Organization, if one exists

settings?: Settings { abuse_contact_email, enforce_twofactor }

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 { analytics, billing, cache_purge, 9 more }

All access permissions for the user at the account.

analytics?: PermissionGrant { read, write }

read?: boolean

write?: boolean

billing?: PermissionGrant { read, write }

read?: boolean

write?: boolean

cache_purge?: PermissionGrant { read, write }

read?: boolean

write?: boolean

dns?: PermissionGrant { read, write }

read?: boolean

write?: boolean

dns_records?: PermissionGrant { read, write }

read?: boolean

write?: boolean

lb?: PermissionGrant { read, write }

read?: boolean

write?: boolean

logs?: PermissionGrant { read, write }

read?: boolean

write?: boolean

organization?: PermissionGrant { read, write }

read?: boolean

write?: boolean

ssl?: PermissionGrant { read, write }

read?: boolean

write?: boolean

waf?: PermissionGrant { read, write }

read?: boolean

write?: boolean

zone_settings?: PermissionGrant { read, write }

read?: boolean

write?: boolean

zones?: PermissionGrant { read, write }

read?: boolean

write?: boolean

roles?: Array<string>

List of role names the membership has for this account.

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

Status of this membership.

One of the following:

"accepted"

"pending"

"rejected"

List Memberships

TypeScript

HTTP

TypeScript

Python

Go

Terraform

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

200 example

{
  "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
  }
}

Returns Examples

200 example

{
  "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
  }
}