--- title: List operation labels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [API Gateway](https://developers.cloudflare.com/api/python/resources/api_gateway) [Labels](https://developers.cloudflare.com/api/python/resources/api_gateway/subresources/labels) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List operation labels api\_gateway.labels.list(LabelListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[LabelListResponse]()] 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 zone\_id: str Identifier. maxLength32 [Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
direction: Optional\[Literal\["asc", "desc"]] Direction to order results. One of the following: "asc" Link to this property "desc" Link to this property
[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>) filter: Optional\[str] Filter for labels where the name or description matches using substring match [Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20filter%20%3E%20(schema)>)
order: Optional\[Literal\["name", "description", "created\_at", 2 more]] Field to order by One of the following: "name" Link to this property "description" Link to this property "created\_at" Link to this property "last\_updated" Link to this property "mapped\_resources.operations" Link to this property
[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20order%20%3E%20(schema)>) page: Optional\[int] Page number of paginated results. minimum1 [Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: Optional\[int] Maximum number of results per page. maximum50 minimum5 [Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
source: Optional\[Literal\["user", "managed"]] Filter for labels with source One of the following: "user" Link to this property "managed" Link to this property
[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20source%20%3E%20(schema)>) with\_mapped\_resource\_counts: Optional\[[bool]()] Include `mapped_resources` for each label [Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20with_mapped_resource_counts%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class LabelListResponse: … created\_at: datetime formatdate-time Link to this property description: str The description of the label Link to this property last\_updated: datetime formatdate-time Link to this property metadata: object Metadata for the label Link to this property name: str The name of the label Link to this property
source: Literal\["user", "managed"] - user - label is owned by the user - managed - label is owned by cloudflare One of the following: "user" Link to this property "managed" Link to this property
Link to this property mapped\_resources: Optional\[object] 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)%20label_list_response%20%3E%20(schema)>) ### List operation labels Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.api_gateway.labels.list( zone_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.created_at) ``` 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 } } ```