---
title: List Invitations
---

[Skip to content](#_top)

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

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

[Invites](https://developers.cloudflare.com/api/go/resources/user/subresources/invites)

Copy Markdown

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

---

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

# List Invitations

client.User.Invites.List(ctx) (\*SinglePage\[[Invite](<https://developers.cloudflare.com/api/go/resources/user#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>)], error)

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 Write``Memberships Read`

##### ReturnsExpand Collapse

<details>

<summary>

type Invite struct{…}

</summary>

InvitedMemberID string

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>

OrganizationID 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 stringOptional

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>

ExpiresOn TimeOptional

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>

InvitedBy stringOptional

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>

InvitedMemberEmail stringOptional

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>

InvitedOn TimeOptional

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>

OrganizationIsEnforcingTwofactor boolOptional

<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>

OrganizationName stringOptional

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 \[]stringOptional

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 InviteStatusOptional

Current status of the invitation.

</summary>

One of the following:

const InviteStatusPending InviteStatus = "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>

const InviteStatusAccepted InviteStatus = "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>

const InviteStatusRejected InviteStatus = "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>

const InviteStatusExpired InviteStatus = "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)>)

### List Invitations

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.User.Invites.List(context.TODO())
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

200 example

```
{
  "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

200 example

```
{
  "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
  }
}
```