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

Cursor from a previous response's next_cursor field, used to fetch the next page.

limitoptional integer

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

qoptional string

Search query used to filter results.

role_typeoptional stringenumValues:adminuserscanner

Filter by role type code.

include_removedoptional boolean

Whether to include removed account users.

objectstringenumValues:list

Object type for AccountUser list

page_infoobject

Pagination metadata for AccountUser list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of AccountUser resources in this page

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

namestringnullable

Display name.

emailstringnullable

Email address.

usernamestringnullable

Username.

image_urlstringnullable

Profile image URL.

statusstringenumValues:activedisabledremoved

Account user status.

roleobjectnullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

ownerobjectnullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

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

accountobjectnullable

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.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

default_shipping_addressobjectnullable

Default shipping address.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

is_drop_shipboolean

Whether the address is a drop ship location.

geolocationobjectnullable

Geolocation details for the address.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

brandingobjectnullable

Branding configuration.

idstring

Branding ID.

objectstringenumValues:account_branding

Resource type identifier.

support_emailstringnullable

Support email address.

phone_numberstringnullable

Support phone number.

logo_urlstringnullable

Logo URL (S3 key).

facebook_handlestringnullable

Facebook handle.

instagram_handlestringnullable

Instagram handle.

linkedin_handlestringnullable

LinkedIn handle.

twitter_handlestringnullable

Twitter handle.

website_urlstringnullable

Website URL.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

portalobjectnullable

Portal configuration.

idstring

Portal ID.

objectstringenumValues:account_portal

Resource type identifier.

slugstring

Portal slug.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

permissionsarray of stringnullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentobjectnullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectnullable

Child locations. Expandable.

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

dataarray of object

Array of Location resources in this page

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectnullable

Child locations. Expandable.

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Location resources in this page

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

childrenobjectnullable

Child locations. Expandable.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationsobjectnullable

Scanning stations in this department.

objectstringenumValues:list

Object type for ScanningStation list

page_infoobject

Pagination metadata for ScanningStation list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of ScanningStation resources in this page

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type.

label_sizestringnullableenumValues:1x11x31x4

Label size code.

label_typestringnullableenumValues:tagtraveler

Label type code.

material_check_requiredboolean

Whether material check is required.

departmentobjectnullable

Department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

scanning_stationsobjectnullable

Scanning stations in this department.

machinesobjectnullable

Machines in this department.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

production_stepsobjectnullable

Connected production steps.

objectstringenumValues:list

Object type for ProductionStep list

page_infoobject

Pagination metadata for ProductionStep list

dataarray of object

Array of ProductionStep resources in this page

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

machinesobjectnullable

Machines in this department.

objectstringenumValues:list

Object type for Machine list

page_infoobject

Pagination metadata for Machine list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Machine resources in this page

idstring

Machine ID.

objectstringenumValues:machine

Resource type identifier.

namestring

Display name.

serial_numberstring

Serial number.

notesstringnullable

Notes.

departmentobjectnullable

Associated department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

scanning_stationsobjectnullable

Scanning stations in this department.

machinesobjectnullable

Machines in this department.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

last_used_atstring (date-time)nullable

When the user last used 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

curl API_HOST/v1/identity/account-users \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1"

curl API_HOST/v1/identity/account-users \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1"

200 example

{
  "object": "list",
  "page_info": {
    "next_cursor": "acus_01gf7a8200er3ar3pkfrb6kk29",
    "prev_cursor": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acus_01gf7a8200er3ar3pkfrb6kk29",
      "object": "account_user",
      "name": "John Doe",
      "email": "john@augno.com",
      "username": null,
      "image_url": null,
      "status": "active",
      "role": {
        "id": "rl_01gf7a8200er3ar3pkfrb6kk29",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": {
          "object": "owner",
          "type": "account",
          "account": {
            "id": "ac_01gf7a8200eaj8fke1xvw4h50x",
            "object": "account",
            "name": "Acme Inc.",
            "default_billing_address": null,
            "default_shipping_address": null,
            "branding": null,
            "portal": null,
            "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"
      },
      "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_cursor": "acus_01gf7a8200er3ar3pkfrb6kk29",
    "prev_cursor": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "acus_01gf7a8200er3ar3pkfrb6kk29",
      "object": "account_user",
      "name": "John Doe",
      "email": "john@augno.com",
      "username": null,
      "image_url": null,
      "status": "active",
      "role": {
        "id": "rl_01gf7a8200er3ar3pkfrb6kk29",
        "object": "role",
        "name": "Admin",
        "type": "admin",
        "owner": {
          "object": "owner",
          "type": "account",
          "account": {
            "id": "ac_01gf7a8200eaj8fke1xvw4h50x",
            "object": "account",
            "name": "Acme Inc.",
            "default_billing_address": null,
            "default_shipping_address": null,
            "branding": null,
            "portal": null,
            "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"
      },
      "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