List Account Users

Beta

GET/v1/identity/account-users

This endpoint is idempotent. Learn more

Returns a paginated list of account users for the current account.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

role_typeoptional stringenumValues:adminuserscanner

Filter by role type.

admin: account administrators.
user: users with a custom role.
scanner: scanning station users.
sales_rep: sales representatives.
agent: automated agents.

removed_scopeoptional stringenumValues:excludedincluded

Controls whether removed (soft-deleted) account users appear in the list.

excluded: only active and disabled users (default).
included: removed users are listed as well.

include[]optional arrayenumValues:userroledepartment

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

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while 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

Account user ID.

userobjectExpandablenullable

Underlying user.

idstring

User ID.

objectstringenumValues:user

Resource type identifier.

emailstringnullable

Email address.

namestringnullable

User's full display name.

usernamestringnullable

Username.

email_verified_atstring (date-time)nullable

When the user verified their email address.

image_urlstringnullable

URL of the user's profile image.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

objectstringenumValues:account_user

Resource type identifier.

statusstringenumValues:activedisabledremoved

Account user status.

active: the user can access the account.
disabled: the user is locked out of the account.
removed: the user has been removed (soft-deleted) from the account.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors 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.

admin: full administrative access, including managing API keys.
user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
scanner: a role for scanning-station operators.
sales_rep: a role for sales representatives.
agent: a role assigned to an automated agent rather than a person.

ownerobjectnullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

Always returned as null in this endpoint.

permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentobjectExpandablenullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationobjectnullable

The storage location where this department operates.

Always returned as null in this endpoint.

scanning_stationsobjectnullable

Scanning stations in this department.

Always returned as null in this endpoint.

machinesobjectnullable

Machines in this department.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

last_used_atstring (date-time)nullable

When the user last accessed this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

Responses

200

Successful response for List Account Users

List Account Users

import Augno from '@augno/sdk';

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

const listAccountUser = await client.identity.accountUsers.list();

console.log(listAccountUser.data);

import Augno from '@augno/sdk';

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

const listAccountUser = await client.identity.accountUsers.list();

console.log(listAccountUser.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/identity/account-users?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWN1c18wMWVhOTk4M2RkYjQxZGFjYzQ0ZWNmOTk3YyIsImQiOiJmIn0.qfFtqs2YR9DMRE12AQsoPVmp5fGHSu7DcHNttOVIumA",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acus_01ea9983ddb41dacc44ecf997c",
      "user": {
        "id": "us_0151164dcaea4cbded27b50aae",
        "object": "user",
        "email": "jdoe@augno.com",
        "name": "John Doe",
        "username": "jdoe",
        "email_verified_at": "2026-06-10T00:00:00Z",
        "image_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "object": "account_user",
      "status": "active",
      "role": {
        "id": "rl_01c16d2eb637c0d1f3a372937c",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": null,
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "department": null,
      "last_used_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/identity/account-users?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWN1c18wMWVhOTk4M2RkYjQxZGFjYzQ0ZWNmOTk3YyIsImQiOiJmIn0.qfFtqs2YR9DMRE12AQsoPVmp5fGHSu7DcHNttOVIumA",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acus_01ea9983ddb41dacc44ecf997c",
      "user": {
        "id": "us_0151164dcaea4cbded27b50aae",
        "object": "user",
        "email": "jdoe@augno.com",
        "name": "John Doe",
        "username": "jdoe",
        "email_verified_at": "2026-06-10T00:00:00Z",
        "image_url": "https://cdn.augno.com/avatars/us_0151164dcaea4cbded27b50aae.jpg",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "object": "account_user",
      "status": "active",
      "role": {
        "id": "rl_01c16d2eb637c0d1f3a372937c",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": null,
        "permissions": [
          "customers:create",
          "customers:read",
          "customers:update",
          "customers:delete"
        ],
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "department": null,
      "last_used_at": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Account Users

Query Parameters

Returns

Responses