Account Users

The account_user object

A user's membership in an account, carrying the account-specific status, role, and department.

Profile fields (name, email, username, image URL) live on the expandable user sub-resource, which is shared across every account the user belongs to.

idstring

Account user ID.

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.

rolerolenullable

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.

ownerownernullable

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.

departmentdepartmentnullable

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.

locationlocationnullable

The storage location where this department operates.

Always returned as null in this endpoint.

scanning_stationslistnullable

Scanning stations in this department.

Always returned as null in this endpoint.

machineslistnullable

Machines in this department.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

userusernullable

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.

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.

Used by

POSTBlock UserMessage Blocks GETList BlocksMessage Blocks POSTCreate Account UserAccount Users PATCHUpdate Account UserAccount Users GETList Account UsersAccount Users GETRetrieve Account UserAccount Users PUTActivate Account UserAccount Users PUTDisable Account UserAccount Users PUTRemove Account UserAccount Users POSTCreate CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers POSTMerge CustomersCustomers POSTFind Contact by EmailContacts

account_user example

{
  "id": "acus_01ea9983ddb41dacc44ecf997c",
  "object": "account_user",
  "status": "active",
  "role": {
    "id": "rl_01c16d2eb637c0d1f3a372937c",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": {
      "object": "owner",
      "type": "account",
      "account": {
        "id": "ac_01148680966698341a9c0976db",
        "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,
  "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"
  },
  "last_used_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acus_01ea9983ddb41dacc44ecf997c",
  "object": "account_user",
  "status": "active",
  "role": {
    "id": "rl_01c16d2eb637c0d1f3a372937c",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": {
      "object": "owner",
      "type": "account",
      "account": {
        "id": "ac_01148680966698341a9c0976db",
        "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,
  "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"
  },
  "last_used_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Account Users

Attributes

Used by