--- title: Get Zone Entitlements --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Zones](https://developers.cloudflare.com/api/go/resources/zones) [Entitlements](https://developers.cloudflare.com/api/go/resources/zones/subresources/entitlements) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get Zone Entitlements client.Zones.Entitlements.List(ctx, query) (\*SinglePage\[[EntitlementListResponse]()], error) GET/zones/{zone\_id}/entitlements Returns the list of entitlements (features and their allocations) for a given zone. Each entitlement describes a product feature the zone is permitted to use and the allocation value (boolean, count, range, enum, or string) that governs its behaviour. ##### 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 Read` ##### ParametersExpand Collapse

query EntitlementListParams

ZoneID param.Field\[string] Identifier tag. maxLength32 minLength32 Link to this property

[Link to this property](<#(resource)%20zones.entitlements%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type EntitlementListResponse struct{…} A single entitlement record for a zone or account.

ID string Entitlement identifier — equal to the feature key. Link to this property

Allocation EntitlementListResponseAllocation Represents the allocation value for an entitlement. The shape of value depends on type: bool uses a boolean, max_count uses an integer, enum_number uses an array of numbers, range uses an object with min and max integer fields, and string uses a string.

Type EntitlementListResponseAllocationType Allocation type discriminator.

One of the following: const EntitlementListResponseAllocationTypeBool EntitlementListResponseAllocationType = "bool" Link to this property const EntitlementListResponseAllocationTypeMaxCount EntitlementListResponseAllocationType = "max\_count" Link to this property const EntitlementListResponseAllocationTypeEnumNumber EntitlementListResponseAllocationType = "enum\_number" Link to this property const EntitlementListResponseAllocationTypeRange EntitlementListResponseAllocationType = "range" Link to this property const EntitlementListResponseAllocationTypeString EntitlementListResponseAllocationType = "string" Link to this property

Link to this property

Value EntitlementListResponseAllocationValueUnion Contains the allocation value whose concrete type the type field determines: bool yields a boolean, max\_count yields an integer, enum\_number yields an array of numbers, range yields an object with min and max, and string yields a string.

One of the following: UnionBool Link to this property UnionInt Link to this property UnionString Link to this property type EntitlementListResponseAllocationValueArray \[]float64 Link to this property

type EntitlementListResponseAllocationValueObject struct{…}

Max int64 Link to this property Min int64 Link to this property

Link to this property

Link to this property CreatedDate string ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was created. Format: YYYY-MM-DDTHH:MM:SS.ffffff. Link to this property DeletedDate string ISO 8601 timestamp when the entitlement was deleted, or empty string if not deleted. Link to this property EditedDate string ISO 8601 timestamp (microsecond precision, no timezone offset) when the entitlement was last edited. Link to this property

Feature EntitlementListResponseFeature Describes a product feature associated with an entitlement.

ID int64 Numeric identifier of the feature. formatint64 Link to this property FeatureSet string The logical grouping (set) this feature belongs to. Link to this property Key string Unique string key for the feature. Link to this property Name string Human-readable name of the feature. Link to this property

Link to this property

[Link to this property](<#(resource)%20zones.entitlements%20%3E%20(model)%20EntitlementListResponse%20%3E%20(schema)>) ### Get Zone Entitlements 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.Entitlements.List(context.TODO(), zones.EntitlementListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 200 example 400 example 404 example 405 example 500 example 503 example ``` { "errors": [], "messages": [], "result": [ { "allocation": { "type": "max_count", "value": 3 }, "created_date": "2021-09-17T20:33:36.000000", "deleted_date": "", "edited_date": "2021-09-17T20:34:01.000000", "feature": { "feature_set": "page_rules", "id": 1, "key": "page_rules", "name": "Page Rules" }, "id": "page_rules" }, { "allocation": { "type": "bool", "value": true }, "created_date": "2021-09-17T20:39:02.000000", "deleted_date": "", "edited_date": "2021-09-17T20:39:11.000000", "feature": { "feature_set": "argo", "id": 38, "key": "argo.allow_tiered_caching", "name": "Argo Tiered Cache" }, "id": "argo.allow_tiered_caching" }, { "allocation": { "type": "enum_number", "value": [ 10, 60, 600, 3600 ] }, "created_date": "2021-09-17T20:47:36.000000", "deleted_date": "", "edited_date": "2021-09-17T20:47:43.000000", "feature": { "feature_set": "rate_limiting", "id": 32, "key": "rate_limiting.sampling_period_secs", "name": "rate_limiting.sampling_period_secs" }, "id": "rate_limiting.sampling_period_secs" } ], "success": true } ``` ``` { "errors": [ { "code": 2005, "message": "failed to fetch entitlements: invalid object type" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2004, "message": "failed to fetch entitlements: unknown route" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2001, "message": "failed to fetch entitlements: method not allowed" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2000, "message": "failed to fetch entitlements: internal server error" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2003, "message": "failed to fetch entitlements: timeout occurred" } ], "messages": [], "result": null, "success": false } ``` ##### Returns Examples 200 example 400 example 404 example 405 example 500 example 503 example ``` { "errors": [], "messages": [], "result": [ { "allocation": { "type": "max_count", "value": 3 }, "created_date": "2021-09-17T20:33:36.000000", "deleted_date": "", "edited_date": "2021-09-17T20:34:01.000000", "feature": { "feature_set": "page_rules", "id": 1, "key": "page_rules", "name": "Page Rules" }, "id": "page_rules" }, { "allocation": { "type": "bool", "value": true }, "created_date": "2021-09-17T20:39:02.000000", "deleted_date": "", "edited_date": "2021-09-17T20:39:11.000000", "feature": { "feature_set": "argo", "id": 38, "key": "argo.allow_tiered_caching", "name": "Argo Tiered Cache" }, "id": "argo.allow_tiered_caching" }, { "allocation": { "type": "enum_number", "value": [ 10, 60, 600, 3600 ] }, "created_date": "2021-09-17T20:47:36.000000", "deleted_date": "", "edited_date": "2021-09-17T20:47:43.000000", "feature": { "feature_set": "rate_limiting", "id": 32, "key": "rate_limiting.sampling_period_secs", "name": "rate_limiting.sampling_period_secs" }, "id": "rate_limiting.sampling_period_secs" } ], "success": true } ``` ``` { "errors": [ { "code": 2005, "message": "failed to fetch entitlements: invalid object type" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2004, "message": "failed to fetch entitlements: unknown route" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2001, "message": "failed to fetch entitlements: method not allowed" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2000, "message": "failed to fetch entitlements: internal server error" } ], "messages": [], "result": null, "success": false } ``` ``` { "errors": [ { "code": 2003, "message": "failed to fetch entitlements: timeout occurred" } ], "messages": [], "result": null, "success": false } ```