List Invitations

client.User.Invites.List(ctx) (*SinglePage[Invite], 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 WriteMemberships Read

ReturnsExpand Collapse

type Invite struct{…}

InvitedMemberID string

ID of the user to add to the organization.

maxLength32

OrganizationID string

ID of the organization the user will be added to.

maxLength32

ID stringoptional

Invite identifier tag.

maxLength32

ExpiresOn Timeoptional

When the invite is no longer active.

formatdate-time

InvitedBy stringoptional

The email address of the user who created the invite.

maxLength90

InvitedMemberEmail stringoptional

Email address of the user to add to the organization.

maxLength90

InvitedOn Timeoptional

When the invite was sent.

formatdate-time

OrganizationIsEnforcingTwofactor booloptional

OrganizationName stringoptional

Organization name.

maxLength100

Roles []stringoptional

List of role names the membership has for this account.

Status InviteStatusoptional

Current status of the invitation.

One of the following:

const InviteStatusPending InviteStatus = "pending"

const InviteStatusAccepted InviteStatus = "accepted"

const InviteStatusRejected InviteStatus = "rejected"

const InviteStatusExpired InviteStatus = "expired"

List Invitations

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

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