Retrieve Account Status

Beta

GET/v1/sales/account-statuses/{id}

This endpoint is idempotent. Learn more

Returns an account status by ID or code.

idstring

Account status ID or code.

include[]optional arrayenumValues:owner

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

idstring

Account status ID.

objectstringenumValues:account_status

Resource type identifier.

codestringenumValues:normalpreferredhold_shipment

Machine-readable status code.

This is the value used as a customer's status.

normal: standard account with no restrictions.
preferred: account flagged as preferred (e.g. for prioritized handling).
hold_shipment: shipments to this account are held; orders may still be placed.
hold_all: all activity for this account is held.

namestring

Human-readable label for the status.

ownerownerExpandablenullable

Owner of this resource.

Account statuses are system-owned platform defaults shared across all accounts.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Retrieve Account Status

Retrieve Account Status

import Augno from '@augno/sdk';

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

const accountStatus = await client.sales.accountStatuses.retrieve(
  'acss_01004f532c58d60514b685cb27',
);

console.log(accountStatus.id);

import Augno from '@augno/sdk';

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

const accountStatus = await client.sales.accountStatuses.retrieve(
  'acss_01004f532c58d60514b685cb27',
);

console.log(accountStatus.id);

200 example

{
  "id": "acss_01004f532c58d60514b685cb27",
  "object": "account_status",
  "code": "normal",
  "name": "Normal",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acss_01004f532c58d60514b685cb27",
  "object": "account_status",
  "code": "normal",
  "name": "Normal",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Account Status

Path Parameters

Query Parameters

Returns

Responses