# cannedRoles

query · in the family [Reading your records](/reference/reading-your-records/)

## What it does

The canned role list — each entry is a platform-preset role template you can copy into your group.

The 7 canned role templates: copy via copyCannedRole. NOT a construct list (bounded 7 forever — the transferLanes roster class; untouched). Requires authentication.

## What happens

Reads only — changes nothing.

## Who may call it

Capability area: **Reading your records** — Looking up and listing the records of your organization.

- Owner
- System Administrator
- Manager
- Associate Manager
- Sales Associate
- An API key whose scope allows `api:cannedRoles`

## Returns

[CannedRole](/types/CannedRole/) `[CannedRole!]!` — One canned role template: usable via copyCannedRole → an ordinary editable group Role. Hard boundaries are explicit disallow rows; amounts NEVER appear.

## Example request

```graphql
query ExampleCannedRoles {
  cannedRoles {
    key
    caption
    version
    authorityTier
  }
}
```

## Example response

```json
{
  "data": {
    "cannedRoles": [
      {
        "key": "owner",
        "caption": "Blue jeans",
        "version": 1,
        "authorityTier": "owner"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))