--- title: List Zones --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Zones](https://developers.cloudflare.com/api/go/resources/zones) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Zones client.Zones.List(ctx, query) (\*V4PagePaginationArray\[[Zone]()], error) GET/zones Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts is currently not allowed. ##### 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
##### Accepted Permissions (at least one required) `Zone Zone Read` ##### ParametersExpand Collapse
query ZoneListParams
Account param.Field\[ZoneListParamsAccount]Optional ID stringOptional Filter by an account ID. Link to this property Name stringOptional An account Name. Optional filter operators can be provided to extend refine the search: - equal (default) - not_equal - starts_with - ends_with - contains - starts_with_case_sensitive - ends_with_case_sensitive - contains_case_sensitive maxLength253 Link to this property
Link to this property
Direction param.Field\[ZoneListParamsDirection]Optional Direction to order zones. const ZoneListParamsDirectionAsc ZoneListParamsDirection = "asc" Link to this property const ZoneListParamsDirectionDesc ZoneListParamsDirection = "desc" Link to this property
Link to this property
Match param.Field\[ZoneListParamsMatch]Optional Whether to match all search requirements or at least one (any). const ZoneListParamsMatchAny ZoneListParamsMatch = "any" Link to this property const ZoneListParamsMatchAll ZoneListParamsMatch = "all" Link to this property
Link to this property Name param.Field\[string]Optional A domain name. Optional filter operators can be provided to extend refine the search: - equal (default) - not_equal - starts_with - ends_with - contains - starts_with_case_sensitive - ends_with_case_sensitive - contains_case_sensitive maxLength253 Link to this property
Order param.Field\[ZoneListParamsOrder]Optional Field to order zones by. const ZoneListParamsOrderName ZoneListParamsOrder = "name" Link to this property const ZoneListParamsOrderStatus ZoneListParamsOrder = "status" Link to this property const ZoneListParamsOrderAccountID ZoneListParamsOrder = "account.id" Link to this property const ZoneListParamsOrderAccountName ZoneListParamsOrder = "account.name" Link to this property const ZoneListParamsOrderPlanID ZoneListParamsOrder = "plan.id" Link to this property
Link to this property Page param.Field\[float64]Optional Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Number of zones per page. maximum50 minimum5 Link to this property
Status param.Field\[ZoneListParamsStatus]Optional Specify a zone status to filter by. const ZoneListParamsStatusInitializing ZoneListParamsStatus = "initializing" Link to this property const ZoneListParamsStatusPending ZoneListParamsStatus = "pending" Link to this property const ZoneListParamsStatusActive ZoneListParamsStatus = "active" Link to this property const ZoneListParamsStatusMoved ZoneListParamsStatus = "moved" Link to this property
Link to this property
Type param.Field\[\[]ZoneListParamsType]Optional Zone types to filter by. Multiple types can be specified as a comma-separated list (e.g., ?type=full,partial,secondary). When this parameter is not provided, zones with type “internal” are excluded from the results. const ZoneListParamsTypeFull ZoneListParamsType = "full" Link to this property const ZoneListParamsTypePartial ZoneListParamsType = "partial" Link to this property const ZoneListParamsTypeSecondary ZoneListParamsType = "secondary" Link to this property const ZoneListParamsTypeInternal ZoneListParamsType = "internal" Link to this property
Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Zone struct{…} ID string Identifier maxLength32 Link to this property
Account ZoneAccount The account the zone belongs to. ID stringOptional Identifier maxLength32 Link to this property Name stringOptional The name of the account. Link to this property
Link to this property ActivatedOn Time The last time proof of ownership was detected and the zone was made active. formatdate-time Link to this property CreatedOn Time When the zone was created. formatdate-time Link to this property DevelopmentMode float64 The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is 0. Link to this property
Meta ZoneMeta Metadata about the zone. CDNOnly boolOptional The zone is only configured for CDN. Link to this property CustomCertificateQuota int64Optional Number of Custom Certificates the zone can have. Link to this property DNSOnly boolOptional The zone is only configured for DNS. Link to this property FoundationDNS boolOptional The zone is setup with Foundation DNS. Link to this property PageRuleQuota int64Optional Number of Page Rules a zone can have. Link to this property PhishingDetected boolOptional The zone has been flagged for phishing. Link to this property Step int64Optional Link to this property
Link to this property ModifiedOn Time When the zone was last modified. formatdate-time Link to this property Name string The domain name. Per RFC 1035 the overall zone name can be up to 253 characters, with each segment (“label”) not exceeding 63 characters. maxLength253 Link to this property NameServers \[]string The name servers Cloudflare assigns to a zone. Link to this property OriginalDnshost string DNS host at the time of switching to Cloudflare. maxLength50 Link to this property OriginalNameServers \[]string Original name servers before moving to Cloudflare. Link to this property OriginalRegistrar string Registrar for the domain at the time of switching to Cloudflare. Link to this property
Owner ZoneOwner The owner of the zone. ID stringOptional Identifier maxLength32 Link to this property Name stringOptional Name of the owner. Link to this property Type stringOptional The type of owner. Link to this property
Link to this property
DeprecatedPlan ZonePlan Please use the /zones/{zone_id}/subscription API to update a zone’s plan. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans. A Zones subscription information. ID stringOptional Identifier maxLength32 Link to this property CanSubscribe boolOptional States if the subscription can be activated. Link to this property Currency stringOptional The denomination of the customer. Link to this property ExternallyManaged boolOptional If this Zone is managed by another company. Link to this property Frequency stringOptional How often the customer is billed. Link to this property IsSubscribed boolOptional States if the subscription active. Link to this property LegacyDiscount boolOptional If the legacy discount applies to this Zone. Link to this property LegacyID stringOptional The legacy name of the plan. Link to this property Name stringOptional Name of the owner. Link to this property Price float64Optional How much the customer is paying. Link to this property
Link to this property CNAMESuffix stringOptional Allows the customer to use a custom apex. *Tenants Only Configuration*. Link to this property Paused boolOptional Indicates whether the zone is only using Cloudflare DNS services. A true value means the zone will not receive security or performance benefits. Link to this property DeprecatedPermissions \[]stringOptional This has been replaced by Account memberships. Legacy permissions based on legacy user membership information. Link to this property
Status ZoneStatusOptional The zone status on Cloudflare. One of the following: const ZoneStatusInitializing ZoneStatus = "initializing" Link to this property const ZoneStatusPending ZoneStatus = "pending" Link to this property const ZoneStatusActive ZoneStatus = "active" Link to this property const ZoneStatusMoved ZoneStatus = "moved" Link to this property
Link to this property
Tenant ZoneTenantOptional The root organizational unit that this zone belongs to (such as a tenant or organization). ID stringOptional Identifier maxLength32 Link to this property Name stringOptional The name of the Tenant account. Link to this property
Link to this property
TenantUnit ZoneTenantUnitOptional The immediate parent organizational unit that this zone belongs to (such as under a tenant or sub-organization). ID stringOptional Identifier maxLength32 Link to this property
Link to this property
Type TypeOptional A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. One of the following: const TypeFull Type = "full" Link to this property const TypePartial Type = "partial" Link to this property const TypeSecondary Type = "secondary" Link to this property const TypeInternal Type = "internal" Link to this property
Link to this property VanityNameServers \[]stringOptional An array of domains used for custom name servers. This is only available for Business and Enterprise plans. Link to this property VerificationKey stringOptional Verification key for partial zone setup. Link to this property
[Link to this property](<#(resource)%20zones%20%3E%20(model)%20zone%20%3E%20(schema)>) ### List Zones Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/zones" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Zones.List(context.TODO(), zones.ZoneListParams{ }) 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": "023e105f4ecef8ad9ca31a8372d0c353", "account": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Example Account Name" }, "activated_on": "2014-01-02T00:01:00.12345Z", "created_on": "2014-01-01T05:20:00.12345Z", "development_mode": 7200, "meta": { "cdn_only": true, "custom_certificate_quota": 1, "dns_only": true, "foundation_dns": true, "page_rule_quota": 100, "phishing_detected": false, "step": 2 }, "modified_on": "2014-01-01T05:20:00.12345Z", "name": "example.com", "name_servers": [ "bob.ns.cloudflare.com", "lola.ns.cloudflare.com" ], "original_dnshost": "NameCheap", "original_name_servers": [ "ns1.originaldnshost.com", "ns2.originaldnshost.com" ], "original_registrar": "GoDaddy", "owner": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Example Org", "type": "organization" }, "plan": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "can_subscribe": false, "currency": "USD", "externally_managed": false, "frequency": "monthly", "is_subscribed": false, "legacy_discount": false, "legacy_id": "free", "name": "Example Org", "price": 10.99 }, "cname_suffix": "cdn.cloudflare.com", "paused": true, "permissions": [ "#worker:read" ], "status": "active", "tenant": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Example Account Name" }, "tenant_unit": { "id": "023e105f4ecef8ad9ca31a8372d0c353" }, "type": "full", "vanity_name_servers": [ "ns1.example.com", "ns2.example.com" ], "verification_key": "284344499-1084221259" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ``` ##### 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": "023e105f4ecef8ad9ca31a8372d0c353", "account": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Example Account Name" }, "activated_on": "2014-01-02T00:01:00.12345Z", "created_on": "2014-01-01T05:20:00.12345Z", "development_mode": 7200, "meta": { "cdn_only": true, "custom_certificate_quota": 1, "dns_only": true, "foundation_dns": true, "page_rule_quota": 100, "phishing_detected": false, "step": 2 }, "modified_on": "2014-01-01T05:20:00.12345Z", "name": "example.com", "name_servers": [ "bob.ns.cloudflare.com", "lola.ns.cloudflare.com" ], "original_dnshost": "NameCheap", "original_name_servers": [ "ns1.originaldnshost.com", "ns2.originaldnshost.com" ], "original_registrar": "GoDaddy", "owner": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Example Org", "type": "organization" }, "plan": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "can_subscribe": false, "currency": "USD", "externally_managed": false, "frequency": "monthly", "is_subscribed": false, "legacy_discount": false, "legacy_id": "free", "name": "Example Org", "price": 10.99 }, "cname_suffix": "cdn.cloudflare.com", "paused": true, "permissions": [ "#worker:read" ], "status": "active", "tenant": { "id": "023e105f4ecef8ad9ca31a8372d0c353", "name": "Example Account Name" }, "tenant_unit": { "id": "023e105f4ecef8ad9ca31a8372d0c353" }, "type": "full", "vanity_name_servers": [ "ns1.example.com", "ns2.example.com" ], "verification_key": "284344499-1084221259" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```