--- title: List Roles --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Accounts](https://developers.cloudflare.com/api/go/resources/accounts) [Roles](https://developers.cloudflare.com/api/go/resources/accounts/subresources/roles) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Roles Deprecated: Use /accounts/{account\_id}/iam/permission\_groups instead. client.Accounts.Roles.List(ctx, params) (\*V4PagePaginationArray\[[Role]()], error) GET/accounts/{account\_id}/roles Get all available roles for an account. ##### Security 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) `SCIM Provisioning``Account Settings Write``Account Settings Read` ##### ParametersExpand Collapse
params RoleListParams AccountID param.Field\[string] Path param: Account identifier tag. maxLength32 minLength32 Link to this property Page param.Field\[float64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param: Number of roles per page. maximum50 minimum5 Link to this property
[Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type Role struct{…} ID string Role identifier tag. maxLength32 Link to this property Description string Description of role’s permissions. Link to this property Name string Role name. maxLength120 Link to this property
Permissions RolePermissions
Analytics PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
Billing PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
CachePurge PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
DNS PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
DNSRecords PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
LB PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
Logs PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
Organization PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
SSL PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
WAF PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
ZoneSettings PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
Zones PermissionGrantOptional Read boolOptional Link to this property Write boolOptional Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20role%20%3E%20(schema)>) ### List Roles Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/accounts" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) page, err := client.Accounts.Roles.List(context.TODO(), accounts.RoleListParams{ 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" } } ], "success": true, "result": [ { "id": "3536bcfad5faccb999b47003c79917fb", "description": "Administrative access to the entire Account", "name": "Account Administrator", "permissions": { "analytics": { "read": true, "write": false }, "billing": { "read": true, "write": false }, "cache_purge": { "read": true, "write": false }, "dns": { "read": true, "write": false }, "dns_records": { "read": true, "write": false }, "lb": { "read": true, "write": false }, "logs": { "read": true, "write": false }, "organization": { "read": true, "write": false }, "ssl": { "read": true, "write": false }, "waf": { "read": true, "write": false }, "zone_settings": { "read": true, "write": false }, "zones": { "read": true, "write": 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" } } ], "success": true, "result": [ { "id": "3536bcfad5faccb999b47003c79917fb", "description": "Administrative access to the entire Account", "name": "Account Administrator", "permissions": { "analytics": { "read": true, "write": false }, "billing": { "read": true, "write": false }, "cache_purge": { "read": true, "write": false }, "dns": { "read": true, "write": false }, "dns_records": { "read": true, "write": false }, "lb": { "read": true, "write": false }, "logs": { "read": true, "write": false }, "organization": { "read": true, "write": false }, "ssl": { "read": true, "write": false }, "waf": { "read": true, "write": false }, "zone_settings": { "read": true, "write": false }, "zones": { "read": true, "write": true } } } ], "result_info": { "count": 1, "page": 1, "per_page": 20, "total_count": 2000 } } ```