---
title: Invites
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[User](https://developers.cloudflare.com/api/typescript/resources/user)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Invites

##### [List Invitations](https://developers.cloudflare.com/api/typescript/resources/user/subresources/invites/methods/list)

client.user.invites.list(RequestOptionsoptions?): SinglePage< [Invite](<https://developers.cloudflare.com/api/typescript/resources/user#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>) {invited\_member\_id, organization\_id, id, 8 more } >

GET/user/invites

##### [Invitation Details](https://developers.cloudflare.com/api/typescript/resources/user/subresources/invites/methods/get)

client.user.invites.get(stringinviteID, RequestOptionsoptions?): [Invite](<https://developers.cloudflare.com/api/typescript/resources/user#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>) {invited\_member\_id, organization\_id, id, 8 more }

GET/user/invites/{invite\_id}

##### [Respond to Invitation](https://developers.cloudflare.com/api/typescript/resources/user/subresources/invites/methods/edit)

client.user.invites.edit(stringinviteID, InviteEditParams {status } body, RequestOptionsoptions?): [Invite](<https://developers.cloudflare.com/api/typescript/resources/user#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>) {invited\_member\_id, organization\_id, id, 8 more }

PATCH/user/invites/{invite\_id}

##### ModelsExpand Collapse

<details>

<summary>

Invite {invited\_member\_id, organization\_id, id, 8 more }

</summary>

invited\_member\_id: string| null

ID of the user to add to the organization.

maxLength32

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20invited_member_id">Link to this property</a>

organization\_id: string

ID of the organization the user will be added to.

maxLength32

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20organization_id">Link to this property</a>

id?: string

Invite identifier tag.

maxLength32

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

expires\_on?: string

When the invite is no longer active.

formatdate-time

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20expires_on">Link to this property</a>

invited\_by?: string

The email address of the user who created the invite.

maxLength90

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20invited_by">Link to this property</a>

invited\_member\_email?: string

Email address of the user to add to the organization.

maxLength90

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20invited_member_email">Link to this property</a>

invited\_on?: string

When the invite was sent.

formatdate-time

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20invited_on">Link to this property</a>

organization\_is\_enforcing\_twofactor?: boolean

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20organization_is_enforcing_twofactor">Link to this property</a>

organization\_name?: string

Organization name.

maxLength100

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20organization_name">Link to this property</a>

roles?: Array&lt;string&gt;

List of role names the membership has for this account.

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20roles">Link to this property</a>

<details>

<summary>

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

Current status of the invitation.

</summary>

One of the following:

"pending"

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%200">Link to this property</a>

"accepted"

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%201">Link to this property</a>

"rejected"

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%202">Link to this property</a>

"expired"

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20status%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)%20%3E%20(property)%20status">Link to this property</a>

</details>

[Link to this property](<#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>)