--- title: Get lists --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Rules Lists](https://developers.cloudflare.com/api/go/resources/rules) [Lists](https://developers.cloudflare.com/api/go/resources/rules/subresources/lists) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get lists client.Rules.Lists.List(ctx, query) (\*SinglePage\[[ListsList]()], error) GET/accounts/{account\_id}/rules/lists Fetches all lists in the 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) `Account Filter Lists Read``Account Filter Lists Edit` ##### ParametersExpand Collapse
query ListListParams AccountID param.Field\[string] The Account ID for this resource. maxLength32 minLength32 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type ListsList struct{…} ID string The unique ID of the list. maxLength32 minLength32 Link to this property CreatedOn string The RFC 3339 timestamp of when the list was created. Link to this property
Kind ListsListKind The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). One of the following: const ListsListKindIP ListsListKind = "ip" Link to this property const ListsListKindRedirect ListsListKind = "redirect" Link to this property const ListsListKindHostname ListsListKind = "hostname" Link to this property const ListsListKindASN ListsListKind = "asn" Link to this property
Link to this property ModifiedOn string The RFC 3339 timestamp of when the list was last modified. Link to this property Name string An informative name for the list. Use this name in filter and rule expressions. maxLength50 Link to this property NumItems float64 The number of items in the list. Link to this property NumReferencingFilters float64 The number of filters referencing the list. Link to this property Description stringOptional An informative summary of the list. maxLength500 Link to this property
[Link to this property](<#(resource)%20rules.lists%20%3E%20(model)%20lists_list%20%3E%20(schema)>) ### Get lists Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/option" "github.com/cloudflare/cloudflare-go/rules" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) page, err := client.Rules.Lists.List(context.TODO(), rules.ListListParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) 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" } } ], "result": [ { "id": "2c0fc9fa937b11eaa1b71c4d701ab86e", "created_on": "2020-01-01T08:00:00Z", "kind": "ip", "modified_on": "2020-01-10T14:00:00Z", "name": "list1", "num_items": 10, "num_referencing_filters": 2, "description": "This is a note" } ], "success": true } ``` ##### 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": "2c0fc9fa937b11eaa1b71c4d701ab86e", "created_on": "2020-01-01T08:00:00Z", "kind": "ip", "modified_on": "2020-01-10T14:00:00Z", "name": "list1", "num_items": 10, "num_referencing_filters": 2, "description": "This is a note" } ], "success": true } ```