--- title: List Tokens --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [User](https://developers.cloudflare.com/api/go/resources/user) [Tokens](https://developers.cloudflare.com/api/go/resources/user/subresources/tokens) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Tokens client.User.Tokens.List(ctx, query) (\*V4PagePaginationArray\[[Token]()], error) GET/user/tokens List all access tokens you 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) `API Tokens Write``API Tokens Read` ##### ParametersExpand Collapse
query TokenListParams
Direction param.Field\[TokenListParamsDirection]Optional Direction to order results. const TokenListParamsDirectionAsc TokenListParamsDirection = "asc" Link to this property const TokenListParamsDirectionDesc TokenListParamsDirection = "desc" Link to this property
Link to this property IncludeExpired param.Field\[bool]Optional When true, includes recently-expired tokens in the response. Link to this property Page param.Field\[float64]Optional Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Maximum number of results per page. maximum50 minimum5 Link to this property
[Link to this property](<#(resource)%20user.tokens%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Token struct{…} ID stringOptional Token identifier tag. maxLength32 Link to this property
Condition TokenConditionOptional
RequestIP TokenConditionRequestIPOptional Client IP restrictions. In \[]TokenConditionCIDRListOptional List of IPv4/IPv6 CIDR addresses. Link to this property NotIn \[]TokenConditionCIDRListOptional List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property CreatorEmailAtCreation stringOptional 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 ExpiresOn TimeOptional The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property IssuedOn TimeOptional The time on which the token was created. formatdate-time Link to this property LastUsedOn TimeOptional Last time the token was used. formatdate-time Link to this property ModifiedOn TimeOptional Last time the token was modified. formatdate-time Link to this property Name stringOptional Token name. maxLength120 Link to this property NotBefore TimeOptional The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
Policies \[]TokenPolicyOptional List of access policies assigned to the token. ID string Policy identifier. Link to this property
Effect TokenPolicyEffect Allow or deny operations against the resources. One of the following: const TokenPolicyEffectAllow TokenPolicyEffect = "allow" Link to this property const TokenPolicyEffectDeny TokenPolicyEffect = "deny" Link to this property
Link to this property
PermissionGroups \[]TokenPolicyPermissionGroup A set of permission groups that are specified to the policy. ID string Identifier of the permission group. Link to this property
Meta TokenPolicyPermissionGroupsMetaOptional Attributes associated to the permission group. Category stringOptional A category used to group permission groups. Link to this property Deprecated stringOptional Indicates whether the permission group is deprecated. Link to this property Description stringOptional Additional information about the permission group. Link to this property Editable stringOptional Indicates whether the permission group can be edited. Link to this property EolAt TimeOptional The planned end-of-life date and time, when provided. formatdate-time Link to this property Label stringOptional A label identifying the permission group. Link to this property Scopes stringOptional The scope associated with the permission group. Link to this property Visibility stringOptional Indicates the permission group’s availability or visibility. Link to this property
Link to this property Name stringOptional Name of the permission group. Link to this property
Link to this property
Resources TokenPolicyResourcesUnion A list of resource names that the policy applies to. One of the following: type TokenPolicyResourcesIAMResourcesTypeObjectString map\[string, string] Map of simple string resource permissions Link to this property type TokenPolicyResourcesIAMResourcesTypeObjectNested map\[string, map\[string, string]] Map of nested resource permissions Link to this property
Link to this property
Link to this property ProvisionerID stringOptional 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 ProvisionerType stringOptional The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
Status TokenStatusOptional Status of the token. One of the following: const TokenStatusActive TokenStatus = "active" Link to this property const TokenStatusDisabled TokenStatus = "disabled" Link to this property const TokenStatusExpired TokenStatus = "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 Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/user" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.User.Tokens.List(context.TODO(), user.TokenListParams{ }) 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" } } ], "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 } } ```