Skip to content
Cloudflare API
Start here
API Reference
User

Invites

List Invitations
client.user.invites.list(RequestOptionsoptions?): SinglePage<Invite { invited_member_id, organization_id, id, 8 more } >
GET/user/invites
Invitation Details
client.user.invites.get(stringinviteId, RequestOptionsoptions?): Invite { invited_member_id, organization_id, id, 8 more }
GET/user/invites/{invite_id}
Respond to Invitation
client.user.invites.edit(stringinviteId, InviteEditParams { status } body, RequestOptionsoptions?): Invite { invited_member_id, organization_id, id, 8 more }
PATCH/user/invites/{invite_id}
ModelsExpand Collapse
Invite { invited_member_id, organization_id, id, 8 more }
invited_member_id: string | null

ID of the user to add to the organization.

maxLength32
organization_id: string

ID of the organization the user will be added to.

maxLength32
id?: string

Invite identifier tag.

maxLength32
expires_on?: string

When the invite is no longer active.

formatdate-time
invited_by?: string

The email address of the user who created the invite.

maxLength90
invited_member_email?: string

Email address of the user to add to the organization.

maxLength90
invited_on?: string

When the invite was sent.

formatdate-time
organization_is_enforcing_twofactor?: boolean
organization_name?: string

Organization name.

maxLength100
roles?: Array<string>

List of role names the membership has for this account.

status?: "pending" | "accepted" | "rejected" | "expired"

Current status of the invitation.

One of the following:
"pending"
"accepted"
"rejected"
"expired"