List Accounts

client.Accounts.List(ctx, query) (*V4PagePaginationArray[Account], error)

GET/accounts

List all accounts you have ownership or verified access to.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

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

ParametersExpand Collapse

query AccountListParams

Direction param.Field[AccountListParamsDirection]Optional

Direction to order results.

const AccountListParamsDirectionAsc AccountListParamsDirection = "asc"

const AccountListParamsDirectionDesc AccountListParamsDirection = "desc"

Name param.Field[string]Optional

Name of the account.

Page param.Field[float64]Optional

Page number of paginated results.

minimum1

PerPage param.Field[float64]Optional

Maximum number of results per page.

maximum50

minimum5

ReturnsExpand Collapse

type Account struct{…}

ID string

Identifier

maxLength32

minLength32

Name string

Account name

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

LegacyFlags AccountLegacyFlagsOptional

Legacy account flags.

EnterpriseZoneQuota AccountLegacyFlagsEnterpriseZoneQuotaOptional

Enterprise zone quota for standard and enterprise accounts. Accounts without a quota have a maximum of 0.

Available int64Optional

Number of additional Enterprise zones available. Returns 0 if the quota is not allocated or is exhausted.

Current int64Optional

Current number of Enterprise zones.

Maximum int64Optional

Maximum number of Enterprise zones allowed.

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

RootOrgID stringOptional

ID of the root Organization, if one exists

maxLength32

ShouldDisplayParentOrgs boolOptional

Indicates whether the parent Organization hierarchy should be displayed

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

List Accounts

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Accounts.List(context.TODO(), accounts.AccountListParams{

  })
  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": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "Demo Account",
      "type": "standard",
      "created_on": "2014-03-01T12:21:02Z",
      "legacy_flags": {
        "enterprise_zone_quota": {
          "available": 168,
          "current": 82,
          "maximum": 250
        }
      },
      "managed_by": {
        "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
        "parent_org_name": "Demo Parent Organization",
        "root_org_id": "46f0a1ce86ec3d91fae00db3b8b48cee",
        "should_display_parent_orgs": true
      },
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "enforce_twofactor": true
      }
    }
  ],
  "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": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "Demo Account",
      "type": "standard",
      "created_on": "2014-03-01T12:21:02Z",
      "legacy_flags": {
        "enterprise_zone_quota": {
          "available": 168,
          "current": 82,
          "maximum": 250
        }
      },
      "managed_by": {
        "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
        "parent_org_name": "Demo Parent Organization",
        "root_org_id": "46f0a1ce86ec3d91fae00db3b8b48cee",
        "should_display_parent_orgs": true
      },
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "enforce_twofactor": true
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}