List Invitations

user.invites.list() -> SyncSinglePage[Invite]

GET/user/invites

Lists all invitations associated with my user.

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)

Memberships WriteMemberships Read

ReturnsExpand Collapse

class Invite: …

invited_member_id: Optional[str]

ID of the user to add to the organization.

maxLength32

organization_id: str

ID of the organization the user will be added to.

maxLength32

id: Optional[str]

Invite identifier tag.

maxLength32

expires_on: Optional[datetime]

When the invite is no longer active.

formatdate-time

invited_by: Optional[str]

The email address of the user who created the invite.

maxLength90

invited_member_email: Optional[str]

Email address of the user to add to the organization.

maxLength90

invited_on: Optional[datetime]

When the invite was sent.

formatdate-time

organization_is_enforcing_twofactor: Optional[bool]

organization_name: Optional[str]

Organization name.

maxLength100

roles: Optional[List[str]]

List of role names the membership has for this account.

status: Optional[Literal["pending", "accepted", "rejected", "expired"]]

Current status of the invitation.

One of the following:

"pending"

"accepted"

"rejected"

"expired"

List Invitations

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.user.invites.list()
page = page.result[0]
print(page.invited_member_id)

{
  "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": [
    {
      "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
      "organization_id": "5a7805061c76ada191ed06f989cc3dac",
      "id": "4f5f0c14a2a41d5063dd301b2f829f04",
      "expires_on": "2014-01-01T05:20:00Z",
      "invited_by": "user@example.com",
      "invited_member_email": "user@example.com",
      "invited_on": "2014-01-01T05:20:00Z",
      "organization_is_enforcing_twofactor": true,
      "organization_name": "Cloudflare, Inc.",
      "roles": [
        "Account Administrator"
      ],
      "status": "accepted"
    }
  ],
  "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": [
    {
      "invited_member_id": "5a7805061c76ada191ed06f989cc3dac",
      "organization_id": "5a7805061c76ada191ed06f989cc3dac",
      "id": "4f5f0c14a2a41d5063dd301b2f829f04",
      "expires_on": "2014-01-01T05:20:00Z",
      "invited_by": "user@example.com",
      "invited_member_email": "user@example.com",
      "invited_on": "2014-01-01T05:20:00Z",
      "organization_is_enforcing_twofactor": true,
      "organization_name": "Cloudflare, Inc.",
      "roles": [
        "Account Administrator"
      ],
      "status": "accepted"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}