Skip to content
Cloudflare API
Start here
API Reference
Accounts
Members

List Members

GET/accounts/{account_id}/members

List all members of an account.

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)
SCIM ProvisioningAccount Settings WriteAccount Settings Read
Path ParametersExpand Collapse
account_id: string

Account identifier tag.

maxLength32
minLength32
Query ParametersExpand Collapse
direction: optional "asc" or "desc"

Direction to order results.

One of the following:
"asc"
"desc"
order: optional "user.first_name" or "user.last_name" or "user.email" or "status"

Field to order results by.

One of the following:
"user.first_name"
"user.last_name"
"user.email"
"status"
page: optional number

Page number of paginated results.

minimum1
per_page: optional number

Maximum number of results per page.

maximum50
minimum5
status: optional "accepted" or "pending" or "rejected"

A member's status in the account.

One of the following:
"accepted"
"pending"
"rejected"
ReturnsExpand Collapse
errors: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
messages: array of object { code, message, documentation_url, source }
code: number
minimum1000
message: string
documentation_url: optional string
source: optional object { pointer }
pointer: optional string
success: true

Whether the API call was successful.

result: optional array of Member { id, email, policies, 3 more }
id: optional string

Membership identifier tag.

maxLength32
email: optional string

The contact email address of the user.

maxLength90
policies: optional array of object { id, access, permission_groups, resource_groups }

Access policy for the membership

id: optional string

Policy identifier.

access: optional "allow" or "deny"

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: optional array of object { id, meta, name }

A set of permission groups that are specified to the policy.

id: string

Identifier of the permission group.

meta: optional object { key, value }

Attributes associated to the permission group.

key: optional string
value: optional string
name: optional string

Name of the permission group.

resource_groups: optional array of object { id, scope, meta, name }

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

scope: array of object { key, objects }

The scope associated to the resource group

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

objects: array of object { key }

A list of scope objects for additional context.

key: string

This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

meta: optional object { key, value }

Attributes associated to the resource group.

key: optional string
value: optional string
name: optional string

Name of the resource group.

roles: optional array of Role { id, description, name, permissions }

Roles assigned to this Member.

id: string

Role identifier tag.

maxLength32
description: string

Description of role's permissions.

name: string

Role name.

maxLength120
permissions: object { analytics, billing, cache_purge, 9 more }
analytics: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
billing: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
cache_purge: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
dns: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
dns_records: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
lb: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
logs: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
organization: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
ssl: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
waf: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
zone_settings: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
zones: optional PermissionGrant { read, write }
read: optional boolean
write: optional boolean
status: optional "accepted" or "pending"

A member's status in the account.

One of the following:
"accepted"
"pending"
user: optional object { email, id, first_name, 2 more }

Details of the user associated to the membership.

email: string

The contact email address of the user.

maxLength90
id: optional string

Identifier

maxLength32
minLength32
first_name: optional string

User's first name

maxLength60
last_name: optional string

User's last name

maxLength60
two_factor_authentication_enabled: optional boolean

Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.

result_info: optional object { count, page, per_page, total_count }
count: optional number

Total number of results for the requested service

page: optional number

Current page within paginated list of results

per_page: optional number

Number of results per page of results

total_count: optional number

Total results available without any search parameters

List Members

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/members \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"
{
  "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",
      "email": "user@example.com",
      "policies": [
        {
          "id": "f267e341f3dd4697bd3b9f71dd96247f",
          "access": "allow",
          "permission_groups": [
            {
              "id": "c8fed203ed3043cba015a93ad1616f1f",
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "Zone Read"
            },
            {
              "id": "82e64a83756745bbbb1c9c2701bf816b",
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "Magic Network Monitoring"
            }
          ],
          "resource_groups": [
            {
              "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
              "scope": [
                {
                  "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
                  "objects": [
                    {
                      "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                    }
                  ]
                }
              ],
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
            }
          ]
        }
      ],
      "roles": [
        {
          "id": "3536bcfad5faccb999b47003c79917fb",
          "description": "Administrative access to the entire Account",
          "name": "Account Administrator",
          "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
            }
          }
        }
      ],
      "status": "accepted",
      "user": {
        "email": "user@example.com",
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "first_name": "John",
        "last_name": "Appleseed",
        "two_factor_authentication_enabled": true
      }
    }
  ],
  "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",
      "email": "user@example.com",
      "policies": [
        {
          "id": "f267e341f3dd4697bd3b9f71dd96247f",
          "access": "allow",
          "permission_groups": [
            {
              "id": "c8fed203ed3043cba015a93ad1616f1f",
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "Zone Read"
            },
            {
              "id": "82e64a83756745bbbb1c9c2701bf816b",
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "Magic Network Monitoring"
            }
          ],
          "resource_groups": [
            {
              "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
              "scope": [
                {
                  "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
                  "objects": [
                    {
                      "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                    }
                  ]
                }
              ],
              "meta": {
                "key": "key",
                "value": "value"
              },
              "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
            }
          ]
        }
      ],
      "roles": [
        {
          "id": "3536bcfad5faccb999b47003c79917fb",
          "description": "Administrative access to the entire Account",
          "name": "Account Administrator",
          "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
            }
          }
        }
      ],
      "status": "accepted",
      "user": {
        "email": "user@example.com",
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "first_name": "John",
        "last_name": "Appleseed",
        "two_factor_authentication_enabled": true
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}