List Invitations

List all invitations associated with an organization.

application/json

Body

result

required

Any of

allOf {2}

array[object (invite) {11}]

allOf {2}

One of

array[object (invite) {11}]

object

expires_on

string <date-time>

schemas-expires_on

read-onlyoptional

When the invite is no longer active.

Example:

2014-01-01T05:20:00Z

string

invite_components-schemas-identifier

read-onlyoptional

Invite identifier tag.

<= 32 characters

Example:

4f5f0c14a2a41d5063dd301b2f829f04

invited_by

string

invited_by

optional

The email address of the user who created the invite.

<= 90 characters

Example:

user@example.com

invited_member_email

string

invited_member_email

optional

Email address of the user to add to the organization.

<= 90 characters

Example:

user@example.com

invited_member_id

string | null

read-onlyrequired

ID of the user to add to the organization.

<= 32 characters

Example:

5a7805061c76ada191ed06f989cc3dac

invited_on

string <date-time>

invited_on

read-onlyoptional

When the invite was sent.

Example:

2014-01-01T05:20:00Z

organization_id

string

read-onlyrequired

ID of the organization the user will be added to.

<= 32 characters

Example:

5a7805061c76ada191ed06f989cc3dac

organization_name

string

read-onlyoptional

Organization name.

<= 100 characters

Example:

Cloudflare, Inc.

roles

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

optional

Roles to be assigned to this user.

organization_is_enforcing_twofactor

boolean

optional

Current status of two-factor enforcement on the organization.

Default:

false

Example:

true

status

enum<string>

optional

Current status of the invitation.

Allowed values:

pendingacceptedrejectedcanceledleftexpired

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": [
        {
            "expires_on": "2014-01-01T05:20:00Z",
            "id": "4f5f0c14a2a41d5063dd301b2f829f04",
            "invited_by": "user@example.com",
            "invited_member_email": "user@example.com",
            "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
            "invited_on": "2014-01-01T05:20:00Z",
            "organization_id": "5a7805061c76ada191ed06f989cc3dac",
            "organization_name": "Cloudflare, Inc.",
            "roles": [
                {
                    "description": "Administrative access to the entire Organization",
                    "id": "3536bcfad5faccb999b47003c79917fb",
                    "name": "Organization Admin",
                    "permissions": [
                        "#zones:read"
                    ]
                }
            ],
            "organization_is_enforcing_twofactor": true,
            "status": "accepted"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses