--- title: List operation labels --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [API Gateway](https://developers.cloudflare.com/api/resources/api_gateway) [Labels](https://developers.cloudflare.com/api/resources/api_gateway/subresources/labels) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List operation labels 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` ##### P ath ParametersExpand Collapse zone\_id: string 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)>) ##### Q uery ParametersExpand Collapse

direction: optional "asc"or "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 string 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 "name"or "description"or "created\_at"or 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 number 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 number 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 "user"or "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 boolean 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

errors: Message { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)

messages: Message { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)

result: array of object {created\_at, description, last\_updated, 4 more }

created\_at: string formatdate-time Link to this property description: string The description of the label Link to this property last\_updated: string 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: "user"or "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 unknown 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(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result\_info: optional object {count, page, per\_page, 2 more }

count: optional number Total number of results for the requested service. Link to this property page: optional number Current page within paginated list of results. Link to this property per\_page: optional number Number of results per page of results. Link to this property total\_count: optional number Total results available without any search parameters. Link to this property total\_pages: optional number The number of total pages in the entire result set. Link to this property

[Link to this property](<#(resource)%20api_gateway.labels%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>) ### List operation labels HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/labels \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 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 } } ```