Skip to content
Start here

List tenant memberships

GET/tenants/{tenant_id}/memberships

List of active members (Cloudflare users) for the Tenant.

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
Path ParametersExpand Collapse
tenant_id: string
ReturnsExpand Collapse
errors: array of unknown
messages: array of ResponseInfo { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
result: array of TenantMembership { user_email, user_name, user_tag }
user_email: string
user_name: string
user_tag: string
success: true

List tenant memberships

curl https://api.cloudflare.com/client/v4/tenants/$TENANT_ID/memberships \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "user_email": "user_email",
      "user_name": "user_name",
      "user_tag": "user_tag"
    }
  ],
  "success": true
}
Returns Examples
{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "user_email": "user_email",
      "user_name": "user_name",
      "user_tag": "user_tag"
    }
  ],
  "success": true
}