List Organizations

Lists organizations the user is associated with.

application/json

Body

result

required

Any of

allOf {2}

array[object (organization) {5}]

allOf {2}

One of

array[object (organization) {5}]

object

string

common_components-schemas-identifier

read-onlyoptional

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

name

string

Cloudflare Client API_schemas-name

optional

Organization name.

<= 100 characters

Example:

Cloudflare, Inc.

permissions

array[string]

schemas-permissions

read-onlyoptional

Access permissions for this User.

roles

array[string]

read-onlyoptional

List of roles that a user has within an organization.

status

enum<string>

components-schemas-status

optional

Whether the user is a member of the organization or has an inivitation pending.

Allowed values:

memberinvited

Example:

member

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": [
        {
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "name": "Cloudflare, Inc.",
            "permissions": [
                "#zones:read"
            ],
            "roles": [
                "All Privileges - Super Administrator"
            ],
            "status": "member"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses