--- title: List Tokens --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Accounts](https://developers.cloudflare.com/api/typescript/resources/accounts) [Tokens](https://developers.cloudflare.com/api/typescript/resources/accounts/subresources/tokens) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Tokens client.accounts.tokens.list(TokenListParams {account\_id, direction, include\_expired, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [Token]() {id, condition, creator\_email\_at\_creation, 10 more } > GET/accounts/{account\_id}/tokens List Account Owned API tokens created for this account. Callers with `com.cloudflare.api.account.token.list_self` permission only receive tokens they created. Results include active, disabled, and recently-expired tokens when `include_expired` is set to true. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` ##### Accepted Permissions (at least one required) `Account API Tokens Write``Account API Tokens Read` ##### ParametersExpand Collapse
params: TokenListParams {account\_id, direction, include\_expired, 2 more } account\_id: string Path param: Account identifier tag. maxLength32 minLength32 Link to this property
direction?: "asc"| "desc" Query param: Direction to order results. One of the following: "asc" Link to this property "desc" Link to this property
Link to this property include\_expired?: boolean Query param: When true, includes recently-expired tokens in the response. Link to this property page?: number Query param: Page number of paginated results. minimum1 Link to this property per\_page?: number Query param: Maximum number of results per page. maximum50 minimum5 Link to this property
[Link to this property](<#(resource)%20accounts.tokens%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
Token {id, condition, creator\_email\_at\_creation, 10 more } id?: string Token identifier tag. maxLength32 Link to this property
condition?: Condition {request\_ip }
request\_ip?: RequestIP {in, not\_in } Client IP restrictions. in?: Array<TokenConditionCIDRList> List of IPv4/IPv6 CIDR addresses. Link to this property not\_in?: Array<TokenConditionCIDRList> List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property creator\_email\_at\_creation?: string The email address of the user who created the token at the time of creation. Only present for Account Owned API Tokens when a creator email was available. maxLength90 Link to this property expires\_on?: string The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on?: string The time on which the token was created. formatdate-time Link to this property last\_used\_on?: string Last time the token was used. formatdate-time Link to this property modified\_on?: string Last time the token was modified. formatdate-time Link to this property name?: string Token name. maxLength120 Link to this property not\_before?: string The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
policies?: Array<TokenPolicy {id, effect, permission\_groups, resources } > List of access policies assigned to the token. id: string Policy identifier. Link to this property
effect: "allow"| "deny" Allow or deny operations against the resources. One of the following: "allow" Link to this property "deny" Link to this property
Link to this property
permission\_groups: Array<PermissionGroup> A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group. category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name?: string Name of the permission group. Link to this property
Link to this property
resources: Record<string, string>| Record<string, Record<string, string>> A list of resource names that the policy applies to. One of the following: Record<string, string> Link to this property Record<string, Record<string, string>> Link to this property
Link to this property
Link to this property provisioner\_id?: string| null The identifier of the service that provisioned the token. For an OAuth-provisioned token, this is the OAuth client identifier. Present when provisioner_type is present and null when the identifier is unavailable. Link to this property provisioner\_type?: string The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
status?: "active"| "disabled"| "expired" Status of the token. One of the following: "active" Link to this property "disabled" Link to this property "expired" Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20token%20%3E%20(schema)>) ### List Tokens 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 token of client.accounts.tokens.list({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', })) { console.log(token.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" } } ], "success": true, "result": [ { "id": "ed17574386854bf78a67040be0a770b0", "condition": { "request_ip": { "in": [ "123.123.123.0/24", "2606:4700::/32" ], "not_in": [ "123.123.123.100/24", "2606:4700:4700::/48" ] } }, "creator_email_at_creation": "user@example.com", "expires_on": "2020-01-01T00:00:00Z", "issued_on": "2018-07-01T05:20:00Z", "last_used_on": "2020-01-02T12:34:00Z", "modified_on": "2018-07-02T05:20:00Z", "name": "readonly token", "not_before": "2018-07-01T05:20:00Z", "policies": [ { "id": "f267e341f3dd4697bd3b9f71dd96247f", "effect": "allow", "permission_groups": [ { "id": "c8fed203ed3043cba015a93ad1616f1f", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "load_balancer_admin", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Zone Read" }, { "id": "82e64a83756745bbbb1c9c2701bf816b", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "fbm_user", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Magic Network Monitoring" } ], "resources": { "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*" } } ], "provisioner_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4", "provisioner_type": "com.cloudflare.api.oauthtoken", "status": "active" } ], "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" } } ], "success": true, "result": [ { "id": "ed17574386854bf78a67040be0a770b0", "condition": { "request_ip": { "in": [ "123.123.123.0/24", "2606:4700::/32" ], "not_in": [ "123.123.123.100/24", "2606:4700:4700::/48" ] } }, "creator_email_at_creation": "user@example.com", "expires_on": "2020-01-01T00:00:00Z", "issued_on": "2018-07-01T05:20:00Z", "last_used_on": "2020-01-02T12:34:00Z", "modified_on": "2018-07-02T05:20:00Z", "name": "readonly token", "not_before": "2018-07-01T05:20:00Z", "policies": [ { "id": "f267e341f3dd4697bd3b9f71dd96247f", "effect": "allow", "permission_groups": [ { "id": "c8fed203ed3043cba015a93ad1616f1f", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "load_balancer_admin", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Zone Read" }, { "id": "82e64a83756745bbbb1c9c2701bf816b", "meta": { "category": "category", "deprecated": "deprecated", "description": "description", "editable": "editable", "eol_at": "2019-12-27T18:11:19.117Z", "label": "fbm_user", "scopes": "com.cloudflare.api.account", "visibility": "visibility" }, "name": "Magic Network Monitoring" } ], "resources": { "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*" } } ], "provisioner_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4", "provisioner_type": "com.cloudflare.api.oauthtoken", "status": "active" } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```