List Roles

Beta

GET/v1/identity/roles

This endpoint is idempotent. Learn more

Returns a paginated list of roles for the target account, including global roles.

cursoroptional string

Cursor token used to retrieve the next or previous page of results.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

types[]optional arrayenumValues:adminuserscanner

Filter by role types.

include[]optional arrayenumValues:ownerowner.accountpermissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

The role's type is sometimes used to gate special behaviors in the frontend and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

ownerobjectExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringExpandablenullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Roles

List Roles

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listRole = await client.identity.roles.list();

console.log(listRole.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listRole = await client.identity.roles.list();

console.log(listRole.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/identity/roles?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicmxfMDFjMTZkMmViNjM3YzBkMWYzYTM3MjkzN2MiLCJkIjoiZiJ9.PY4OTbfVFdeDMKg93RjWlA2WoYHNRL_sTZCN2NOmz-E",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/identity/roles?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicmxfMDFjMTZkMmViNjM3YzBkMWYzYTM3MjkzN2MiLCJkIjoiZiJ9.PY4OTbfVFdeDMKg93RjWlA2WoYHNRL_sTZCN2NOmz-E",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "rl_01c16d2eb637c0d1f3a372937c",
      "object": "role",
      "name": "Admin",
      "type": "admin",
      "owner": {
        "object": "owner",
        "type": "account",
        "account": {
          "id": "ac_01148680966698341a9c0976db",
          "object": "account",
          "name": "Acme Inc.",
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      },
      "permissions": [
        "customers:create",
        "customers:read",
        "customers:update",
        "customers:delete"
      ],
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Roles

Query Parameters

Returns

Responses