--- title: List tunnel routes --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Zero Trust](https://developers.cloudflare.com/api/typescript/resources/zero_trust) [Networks](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/networks) [Routes](https://developers.cloudflare.com/api/typescript/resources/zero_trust/subresources/networks/subresources/routes) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List tunnel routes client.zeroTrust.networks.routes.list(RouteListParams {account\_id, comment, existed\_at, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray< [Teamnet]() {id, comment, created\_at, 7 more } > GET/accounts/{account\_id}/teamnet/routes Lists and filters private network routes in an account. ##### 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) `Cloudflare One Networks Write``Cloudflare One Networks Read``Cloudflare Tunnel Write``Cloudflare Tunnel Read` ##### ParametersExpand Collapse

params: RouteListParams {account\_id, comment, existed\_at, 9 more }

account\_id: string Path param: Cloudflare account ID maxLength32 Link to this property comment?: string Query param: Optional remark describing the route. maxLength100 Link to this property existed\_at?: string Query param: If provided, include only resources that were created (and not deleted) before this time. URL encoded. formaturl-encoded-date-time Link to this property is\_deleted?: boolean Query param: If true, only include deleted routes. If false, exclude deleted routes. If empty, all routes will be included. Link to this property network\_subset?: string Query param: If set, only list routes that are contained within this IP range. Link to this property network\_superset?: string Query param: If set, only list routes that contain this IP range. Link to this property page?: number Query param: Page number of paginated results. minimum1 Link to this property per\_page?: number Query param: Number of results to display. maximum1000 minimum1 Link to this property route\_id?: string Query param: UUID of the route. maxLength36 Link to this property

tun\_types?: Array<"cfd\_tunnel"| "warp\_connector"| "warp"| 4 more> Query param: The types of tunnels to filter by, separated by commas.

One of the following: "cfd\_tunnel" Link to this property "warp\_connector" Link to this property "warp" Link to this property "magic" Link to this property "ip\_sec" Link to this property "gre" Link to this property "cni" Link to this property

Link to this property tunnel\_id?: string Query param: UUID of the tunnel. formatuuid maxLength36 Link to this property virtual\_network\_id?: string Query param: UUID of the virtual network. formatuuid Link to this property

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

Teamnet {id, comment, created\_at, 7 more }

id?: string UUID of the route. maxLength36 Link to this property comment?: string Optional remark describing the route. maxLength100 Link to this property created\_at?: string Timestamp of when the resource was created. formatdate-time Link to this property deleted\_at?: string Timestamp of when the resource was deleted. If null, the resource has not been deleted. formatdate-time Link to this property network?: string The private IPv4 or IPv6 range connected by the route, in CIDR notation. Link to this property

tun\_type?: "cfd\_tunnel"| "warp\_connector"| "warp"| 4 more The type of tunnel.

Link to this property tunnel\_id?: string UUID of the tunnel. formatuuid maxLength36 Link to this property tunnel\_name?: string A user-friendly name for a tunnel. Link to this property virtual\_network\_id?: string UUID of the virtual network. formatuuid Link to this property virtual\_network\_name?: string A user-friendly name for the virtual network. maxLength256 Link to this property

[Link to this property](<#(resource)%20zero_trust.networks.routes%20%3E%20(model)%20teamnet%20%3E%20(schema)>) ### List tunnel routes TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const teamnet of client.zeroTrust.networks.routes.list({ account_id: '699d98642c564d2e855e9661899b7252', })) { console.log(teamnet.id); } ``` 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": [ { "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "comment": "Example comment for this route.", "created_at": "2021-01-25T18:22:34.317854Z", "deleted_at": "2009-11-10T23:00:00Z", "network": "172.16.0.0/16", "tun_type": "cfd_tunnel", "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "tunnel_name": "blog", "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "virtual_network_name": "us-east-1-vpc" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ``` ##### 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": [ { "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "comment": "Example comment for this route.", "created_at": "2021-01-25T18:22:34.317854Z", "deleted_at": "2009-11-10T23:00:00Z", "network": "172.16.0.0/16", "tun_type": "cfd_tunnel", "tunnel_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "tunnel_name": "blog", "virtual_network_id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", "virtual_network_name": "us-east-1-vpc" } ], "success": true, "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```