API Reference

Memberships

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Memberships

client.Memberships.List(ctx, query) (*V4PagePaginationArray[Membership], error)

GET/memberships

List memberships of accounts the user can access.

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

ParametersExpand Collapse

query MembershipListParams

Account param.Field[MembershipListParamsAccount]optional

Name stringoptional

Account name

maxLength100

Direction param.Field[MembershipListParamsDirection]optional

Direction to order memberships.

const MembershipListParamsDirectionAsc MembershipListParamsDirection = "asc"

const MembershipListParamsDirectionDesc MembershipListParamsDirection = "desc"

Name param.Field[string]optional

Account name

maxLength100

Order param.Field[MembershipListParamsOrder]optional

Field to order memberships by.

const MembershipListParamsOrderID MembershipListParamsOrder = "id"

const MembershipListParamsOrderAccountName MembershipListParamsOrder = "account.name"

const MembershipListParamsOrderStatus MembershipListParamsOrder = "status"

Page param.Field[float64]optional

Page number of paginated results.

minimum1

PerPage param.Field[float64]optional

Number of memberships per page.

maximum50

minimum5

Status param.Field[MembershipListParamsStatus]optional

Status of this membership.

const MembershipListParamsStatusAccepted MembershipListParamsStatus = "accepted"

const MembershipListParamsStatusPending MembershipListParamsStatus = "pending"

const MembershipListParamsStatusRejected MembershipListParamsStatus = "rejected"

ReturnsExpand Collapse

type Membership struct{…}

ID stringoptional

Membership identifier tag.

maxLength32

Account Accountoptional

ID string

Identifier

maxLength32

minLength32

Name string

Account name

maxLength100

Type AccountType

One of the following:

const AccountTypeStandard AccountType = "standard"

const AccountTypeEnterprise AccountType = "enterprise"

CreatedOn Timeoptional

Timestamp for the creation of the account

formatdate-time

ManagedBy AccountManagedByoptional

Parent container details

ParentOrgID stringoptional

ID of the parent Organization, if one exists

maxLength32

ParentOrgName stringoptional

Name of the parent Organization, if one exists

Settings AccountSettingsoptional

Account settings

AbuseContactEmail stringoptional

Sets an abuse contact email to notify for abuse reports.

EnforceTwofactor booloptional

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

APIAccessEnabled booloptional

Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

Permissions MembershipPermissionsoptional

All access permissions for the user at the account.

Analytics PermissionGrantoptional

Read booloptional

Write booloptional

Billing PermissionGrantoptional

Read booloptional

Write booloptional

CachePurge PermissionGrantoptional

Read booloptional

Write booloptional

DNS PermissionGrantoptional

Read booloptional

Write booloptional

DNSRecords PermissionGrantoptional

Read booloptional

Write booloptional

LB PermissionGrantoptional

Read booloptional

Write booloptional

Logs PermissionGrantoptional

Read booloptional

Write booloptional

Organization PermissionGrantoptional

Read booloptional

Write booloptional

SSL PermissionGrantoptional

Read booloptional

Write booloptional

WAF PermissionGrantoptional

Read booloptional

Write booloptional

ZoneSettings PermissionGrantoptional

Read booloptional

Write booloptional

Zones PermissionGrantoptional

Read booloptional

Write booloptional

Roles []stringoptional

List of role names the membership has for this account.

Status MembershipStatusoptional

Status of this membership.

One of the following:

const MembershipStatusAccepted MembershipStatus = "accepted"

const MembershipStatusPending MembershipStatus = "pending"

const MembershipStatusRejected MembershipStatus = "rejected"

List Memberships

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.Memberships.List(context.TODO(), memberships.MembershipListParams{

  })
  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": [
    {
      "id": "4536bcfad5faccb111b47003c79917fa",
      "account": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "Demo Account",
        "type": "standard",
        "created_on": "2014-03-01T12:21:02.0000Z",
        "managed_by": {
          "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
          "parent_org_name": "Demo Parent Organization"
        },
        "settings": {
          "abuse_contact_email": "abuse_contact_email",
          "enforce_twofactor": true
        }
      },
      "api_access_enabled": true,
      "permissions": {
        "analytics": {
          "read": true,
          "write": false
        },
        "billing": {
          "read": true,
          "write": false
        },
        "cache_purge": {
          "read": true,
          "write": false
        },
        "dns": {
          "read": true,
          "write": false
        },
        "dns_records": {
          "read": true,
          "write": false
        },
        "lb": {
          "read": true,
          "write": false
        },
        "logs": {
          "read": true,
          "write": false
        },
        "organization": {
          "read": true,
          "write": false
        },
        "ssl": {
          "read": true,
          "write": false
        },
        "waf": {
          "read": true,
          "write": false
        },
        "zone_settings": {
          "read": true,
          "write": false
        },
        "zones": {
          "read": true,
          "write": true
        }
      },
      "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": [
    {
      "id": "4536bcfad5faccb111b47003c79917fa",
      "account": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "Demo Account",
        "type": "standard",
        "created_on": "2014-03-01T12:21:02.0000Z",
        "managed_by": {
          "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
          "parent_org_name": "Demo Parent Organization"
        },
        "settings": {
          "abuse_contact_email": "abuse_contact_email",
          "enforce_twofactor": true
        }
      },
      "api_access_enabled": true,
      "permissions": {
        "analytics": {
          "read": true,
          "write": false
        },
        "billing": {
          "read": true,
          "write": false
        },
        "cache_purge": {
          "read": true,
          "write": false
        },
        "dns": {
          "read": true,
          "write": false
        },
        "dns_records": {
          "read": true,
          "write": false
        },
        "lb": {
          "read": true,
          "write": false
        },
        "logs": {
          "read": true,
          "write": false
        },
        "organization": {
          "read": true,
          "write": false
        },
        "ssl": {
          "read": true,
          "write": false
        },
        "waf": {
          "read": true,
          "write": false
        },
        "zone_settings": {
          "read": true,
          "write": false
        },
        "zones": {
          "read": true,
          "write": true
        }
      },
      "roles": [
        "Account Administrator"
      ],
      "status": "accepted"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}