--- title: List operation labels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [API Gateway](https://developers.cloudflare.com/api/go/resources/api_gateway) [Labels](https://developers.cloudflare.com/api/go/resources/api_gateway/subresources/labels) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List operation labels client.APIGateway.Labels.List(ctx, params) (\*V4PagePaginationArray\[[LabelListResponse]()], error) GET/zones/{zone\_id}/api\_gateway/labels Returns all managed and user-defined labels available for web and API operations in the zone. ##### 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) `Account API Gateway``Account API Gateway Read``Domain API Gateway``Domain API Gateway Read` ##### ParametersExpand Collapse
params LabelListParams ZoneID param.Field\[string] Path param: Identifier. maxLength32 Link to this property
Direction param.Field\[LabelListParamsDirection]Optional Query param: Direction to order results. const LabelListParamsDirectionAsc LabelListParamsDirection = "asc" Link to this property const LabelListParamsDirectionDesc LabelListParamsDirection = "desc" Link to this property
Link to this property Filter param.Field\[string]Optional Query param: Filter for labels where the name or description matches using substring match Link to this property
Order param.Field\[LabelListParamsOrder]Optional Query param: Field to order by const LabelListParamsOrderName LabelListParamsOrder = "name" Link to this property const LabelListParamsOrderDescription LabelListParamsOrder = "description" Link to this property const LabelListParamsOrderCreatedAt LabelListParamsOrder = "created\_at" Link to this property const LabelListParamsOrderLastUpdated LabelListParamsOrder = "last\_updated" Link to this property const LabelListParamsOrderMappedResourcesOperations LabelListParamsOrder = "mapped\_resources.operations" Link to this property
Link to this property Page param.Field\[int64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[int64]Optional Query param: Maximum number of results per page. maximum50 minimum5 Link to this property
Source param.Field\[LabelListParamsSource]Optional Query param: Filter for labels with source const LabelListParamsSourceUser LabelListParamsSource = "user" Link to this property const LabelListParamsSourceManaged LabelListParamsSource = "managed" Link to this property
Link to this property WithMappedResourceCounts param.Field\[bool]Optional Query param: Include mapped_resources for each label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type LabelListResponse struct{…} CreatedAt Time formatdate-time Link to this property Description string The description of the label Link to this property LastUpdated Time formatdate-time Link to this property Metadata unknown Metadata for the label Link to this property Name string The name of the label Link to this property
Source LabelListResponseSource - user - label is owned by the user - managed - label is owned by cloudflare One of the following: const LabelListResponseSourceUser LabelListResponseSource = "user" Link to this property const LabelListResponseSourceManaged LabelListResponseSource = "managed" Link to this property
Link to this property MappedResources unknownOptional Provides counts of what resources are linked to this label Link to this property
[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(model)%20LabelListResponse%20%3E%20(schema)>) ### List operation labels Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/api_gateway" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.APIGateway.Labels.List(context.TODO(), api_gateway.LabelListParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) 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" } } ], "result": [ { "created_at": "2014-01-01T05:20:00.12345Z", "description": "All endpoints that deal with logins", "last_updated": "2014-01-01T05:20:00.12345Z", "metadata": { "foo": "bar" }, "name": "login", "source": "user", "mapped_resources": { "operations": 29 } } ], "success": true, "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" } } ], "result": [ { "created_at": "2014-01-01T05:20:00.12345Z", "description": "All endpoints that deal with logins", "last_updated": "2014-01-01T05:20:00.12345Z", "metadata": { "foo": "bar" }, "name": "login", "source": "user", "mapped_resources": { "operations": 29 } } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000, "total_pages": 100 } } ```