Skip to content
Cloudflare API
Start here
API Reference
Memberships

List Memberships

memberships.list(MembershipListParams**kwargs) -> SyncV4PagePaginationArray[Membership]
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
account: Optional[Account]
name: Optional[str]

Account name

maxLength100
direction: Optional[Literal["asc", "desc"]]

Direction to order memberships.

One of the following:
"asc"
"desc"
name: Optional[str]

Account name

maxLength100
order: Optional[Literal["id", "account.name", "status"]]

Field to order memberships by.

One of the following:
"id"
"account.name"
"status"
page: Optional[float]

Page number of paginated results.

minimum1
per_page: Optional[float]

Number of memberships per page.

maximum50
minimum5
status: Optional[Literal["accepted", "pending", "rejected"]]

Status of this membership.

One of the following:
"accepted"
"pending"
"rejected"
ReturnsExpand Collapse
class Membership: …
id: Optional[str]

Membership identifier tag.

maxLength32
account: Optional[Account]
id: str

Identifier

maxLength32
minLength32
name: str

Account name

maxLength100
type: Literal["standard", "enterprise"]
One of the following:
"standard"
"enterprise"
created_on: Optional[datetime]

Timestamp for the creation of the account

formatdate-time
managed_by: Optional[ManagedBy]

Parent container details

parent_org_id: Optional[str]

ID of the parent Organization, if one exists

maxLength32
parent_org_name: Optional[str]

Name of the parent Organization, if one exists

settings: Optional[Settings]

Account settings

abuse_contact_email: Optional[str]

Sets an abuse contact email to notify for abuse reports.

enforce_twofactor: Optional[bool]

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

api_access_enabled: Optional[bool]

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

permissions: Optional[Permissions]

All access permissions for the user at the account.

analytics: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
billing: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
cache_purge: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
dns: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
dns_records: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
lb: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
logs: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
organization: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
ssl: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
waf: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
zone_settings: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
zones: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
roles: Optional[List[str]]

List of role names the membership has for this account.

status: Optional[Literal["accepted", "pending", "rejected"]]

Status of this membership.

One of the following:
"accepted"
"pending"
"rejected"

List Memberships

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.memberships.list()
page = page.result[0]
print(page.id)
{
  "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
{
  "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
  }
}