Skip to content
Cloudflare API
Start here
API Reference
User

Invites

List Invitations
user.invites.list() -> SyncSinglePage[Invite]
GET/user/invites
Invitation Details
user.invites.get(strinvite_id) -> Invite
GET/user/invites/{invite_id}
Respond to Invitation
user.invites.edit(strinvite_id, InviteEditParams**kwargs) -> Invite
PATCH/user/invites/{invite_id}
ModelsExpand 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"