List Members

List all members of a organization.

application/json

Body

result

required

Any of

allOf {2}

array[object (components-schemas-member) {5}]

allOf {2}

One of

array[object (components-schemas-member) {5}]

object

string

Cloudflare Client API_email

required

The contact email address of the user.

<= 90 characters

Example:

user@example.com

string

common_components-schemas-identifier

read-onlyrequired

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

name

string | null

member_components-schemas-name

required

Member Name.

<= 100 characters

Example:

John Smith

roles

array[object (schemas-role) {4}]

required

Roles assigned to this Member.

status

required

A member's status in the organization.

Allowed values:

acceptedinvited

Example:

accepted

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "email": "user@example.com",
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "name": "John Smith",
            "roles": [
                {
                    "description": "Administrative access to the entire Organization",
                    "id": "3536bcfad5faccb999b47003c79917fb",
                    "name": "Organization Admin",
                    "permissions": [
                        "#zones:read"
                    ]
                }
            ],
            "status": "accepted"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses