List Customers

Beta
GET/v1/sales/customers

This endpoint is idempotent. Learn more

Returns a paginated list of customers 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.

customer_group_ids[]optional array

Filter by customer type group IDs (the account group of type type_group returned in the customer's type field).

pricing_group_ids[]optional array

Filter to customers that belong to any of these pricing groups.

sales_rep_ids[]optional array

Filter by default sales rep IDs.

status_codes[]optional arrayenumValues:normalpreferredhold_shipment

Filter by account status codes.

shipping_term_ids[]optional array

Filter by default shipping term IDs.

payment_term_ids[]optional array

Filter by default payment term IDs.

commission_status_codes[]optional arrayenumValues:commission_appliedcommission_exempt

Filter by commission policy.

freight_status_codes[]optional arrayenumValues:free_freightbilled_freight

Filter by freight policy.

carrier_ids[]optional array

Filter by default carrier IDs.

service_level_ids[]optional array

Filter by default service level IDs.

parent_account_statusoptional stringenumValues:parentnon_parent

Filter by whether the customer has child accounts.

cityoptional string

Filter to customers with any address in this city (exact match).

When combined with state or postal_code, a single address must match all provided values.

stateoptional string

Filter to customers with any address in this state (exact match).

postal_codeoptional string

Filter to customers with any address in this postal code (exact match).

start_dateoptional string (date-time)

Filter to customers created at or after this timestamp (inclusive).

end_dateoptional string (date-time)

Filter to customers created at or before this timestamp (inclusive).

include[]optional arrayenumValues:bill_to_addressship_to_addresstype

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

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

  • normal: standard active account with no restrictions.
  • preferred: active account flagged as preferred.
  • hold_shipment: orders can be placed, but shipments are held.
  • hold_all: all activity is on hold.
edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

  • standalone: no parent or child accounts.
  • parent: has one or more child accounts (see child_accounts).
  • child: belongs to a parent account (see parent_account).
commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

  • commission_exempt: this customer's orders are exempt from sales commission.
  • commission_applied: sales commission is calculated on this customer's orders.
notestringnullable

Free-form note about the customer.

credit_limitobjectExpandablenullable

Maximum credit extended to this customer.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Raw decimal value of the quantity, as a string to preserve precision.

This is the unformatted machine value; see display_value for the human-readable rendering with unit and thousands separators.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitobjectnullable

Unit of measure for this value (e.g. a currency, mass, or count unit).

Always returned as null in this endpoint.
contact_infoobjectExpandablenullable

Contact information.

objectstringenumValues:customer_contact_info

Resource type identifier.

emailstringnullable

Email address.

phonestringnullable

Phone number.

urlstringnullable

Website URL.

freight_preferencesobjectExpandablenullable

Freight and carrier preferences applied to this customer's shipments.

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy applied to this customer's orders.

  • free_freight: the customer is not billed for freight.
  • billed_freight: freight is billed to the customer, unless overridden elsewhere.
carrierobjectExpandablenullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Human-readable name for the carrier, unique among your account's carriers.

codestringnullableenumValues:fedexupsusps

Well-known carrier identifier, set only for recognized carriers and absent for custom ones.

  • fedex, ups, usps: integrated carriers managed through Shippo (live rating and labels).
  • will_call: customer picks the order up; no carrier shipment.
  • delivery: delivered by your own vehicles/drivers.
  • ltl, ltl1: less-than-truckload freight carriers.
  • freight_collect: freight billed to and arranged by the receiver.
account_numberstringnullable

Your account number with this carrier, used to connect UPS and USPS accounts.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this carrier at checkout in the customer portal.

ownerobjectnullable

Provenance of this carrier.

System-owned carriers are platform-provided defaults shared across all accounts and cannot be deleted; account-owned carriers are custom to your account.

Always returned as null in this endpoint.
service_levelsobjectnullable

Shipping service levels offered by this carrier (e.g. ground, overnight).

Always returned as null in this endpoint.
deleted_atstring (date-time)nullable

Soft-delete timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

service_levelobjectExpandablenullable

Default service level.

idstring

Service level ID.

objectstringenumValues:service_level

Resource type identifier.

namestring

Human-readable name for the service level, shown to customers at checkout when the service level is visible.

service_level_tokenstring

Carrier-specific code identifying this service level (e.g. fedex_ground, ups_next_day_air).

Values are carrier-defined, so any non-empty string is accepted.

customer_portal_visibilitystringenumValues:visiblehidden

Whether customers can see and select this service level at checkout in the customer portal.

is_defaultboolean

Whether this is the carrier's default service level, pre-selected when the carrier is chosen.

Each carrier has at most one default; setting a new default clears the previous one.

ownerobjectnullable

Provenance of this service level.

System-owned service levels are platform-provided defaults that cannot be updated or deleted; account-owned service levels are custom to your account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Who pays the carrier for shipments.

  • sender: the shipper (you) pays the carrier.
  • third_party: a third party is billed, using billing_account.
billing_accountstringnullable

Carrier billing account number charged when billing_type is third_party.

defaultsobjectExpandablenullable

Default settings applied to new orders for this customer.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termobjectExpandablenullable

Default payment term.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name (e.g. Net 30).

statusstringenumValues:activeinactive

Lifecycle status of the payment term.

ownerobjectnullable

Owner of this resource, indicating whether it is an Augno-provided system default or was created by your account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

shipping_termobjectExpandablenullable

Default shipping term.

idstring

Shipping term ID.

objectstringenumValues:shipping_term

Resource type identifier.

namestring

Human-readable name for the shipping term, used to identify it when assigning shipping terms to customers and orders.

typestringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Freight pricing model applied by this shipping term.

  • free_freight: no shipping cost to the buyer.
  • flat_rate_freight: a fixed shipping cost regardless of order details (see flat_rate).
  • carrier_rate_freight: shipping cost is determined by the carrier's quoted rate.
ownerobjectnullable

Provenance of this shipping term.

System-owned shipping terms are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned shipping terms are custom to your account.

Always returned as null in this endpoint.
flat_rateobjectnullable

Fixed shipping charge applied to the order.

Applied only when type is flat_rate_freight; ignored for other freight pricing models.

Always returned as null in this endpoint.
minimum_order_valueobjectnullable

Order subtotal a buyer must reach before this term's free-shipping rules apply.

Always returned as null in this endpoint.
free_shipping_service_levelsobjectnullable

Service levels that ship for free under this term (typically once minimum_order_value is met).

Always returned as null in this endpoint.
created_atstring (date-time)

When this shipping term was created.

updated_atstring (date-time)

When this shipping term was last updated.

priorityobjectExpandablenullable

Default priority.

idstring

Priority ID.

objectstringenumValues:priority

Resource type identifier.

codestringenumValues:lownormalhigh

Machine-readable code identifying the priority level.

  • low: lowest urgency; worked after normal and high.
  • normal: default urgency for most orders and picks.
  • high: highest urgency; worked ahead of normal and low.
namestring

Display name.

ownerobjectnullable

Owner of this resource.

Priorities are platform-provided and shared across all accounts, so the owner is always the Augno system owner.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

sales_repobjectExpandablenullable

Default sales rep.

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.
roleobjectnullable

Assigned role.

Always returned as null in this endpoint.
departmentobjectnullable

Assigned department.

Always returned as null in this endpoint.
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.

notification_preferencesobjectExpandablenullable

Notification preferences.

objectstringenumValues:customer_notification_preferences

Resource type identifier.

accepts_invoice_emailsboolean

Whether invoice emails are accepted.

bill_to_addressobjectExpandablenullable

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.

typestringenumValues:standarddrop_ship

Address type.

  • standard: a normal shipping or billing address.
  • drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.
geolocationobjectnullable

Geolocation details for the address.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ship_to_addressobjectExpandablenullable

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.

typestringenumValues:standarddrop_ship

Address type.

  • standard: a normal shipping or billing address.
  • drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.
geolocationobjectnullable

Geolocation details for the address.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

typeobjectExpandablenullable

The account group of type type_group that categorizes this customer (for example "Distributors").

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupsobjectExpandablenullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

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 group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name of the account group.

Unique within the account.

descriptionstringnullable

Free-form description of the account group.

commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to accounts in this group.

  • commission_applied: sales commission is calculated on orders from accounts in this group.
  • commission_exempt: orders from accounts in this group are exempt from commission.
freight_policystringenumValues:free_freightbilled_freight

How freight charges apply to orders from accounts in this group.

  • free_freight: customers within this group will not have to pay for freight.
  • billed_freight: freight will be applied to any order within this account group, unless overridden elsewhere.
typestringenumValues:pricing_grouptype_group

How this account group is used.

  • pricing_group: used for pricing rules, such as a "Preferred" group that receives a special discount.
  • type_group: used to categorize accounts, such as "Consumers" or "Distributors".
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

parent_accountobjectExpandablenullable

Parent account.

Present if this is a child account.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

  • normal: standard active account with no restrictions.
  • preferred: active account flagged as preferred.
  • hold_shipment: orders can be placed, but shipments are held.
  • hold_all: all activity is on hold.
edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

  • standalone: no parent or child accounts.
  • parent: has one or more child accounts (see child_accounts).
  • child: belongs to a parent account (see parent_account).
commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

  • commission_exempt: this customer's orders are exempt from sales commission.
  • commission_applied: sales commission is calculated on this customer's orders.
notestringnullable

Free-form note about the customer.

credit_limitobjectnullable

Maximum credit extended to this customer.

Always returned as null in this endpoint.
contact_infoobjectnullable

Contact information.

Always returned as null in this endpoint.
freight_preferencesobjectnullable

Freight and carrier preferences applied to this customer's shipments.

Always returned as null in this endpoint.
defaultsobjectnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.
notification_preferencesobjectnullable

Notification preferences.

Always returned as null in this endpoint.
bill_to_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.
ship_to_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.
typeobjectnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

Always returned as null in this endpoint.
price_groupsobjectnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

Always returned as null in this endpoint.
parent_accountobjectnullable

Parent account.

Present if this is a child account.

Always returned as null in this endpoint.
child_accountsobjectnullable

Child accounts.

Present if this is a parent account.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

child_accountsobjectExpandablenullable

Child accounts.

Present if this is a parent account.

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

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

The customer's business name, as shown throughout the app and on documents.

numberstring

Human-readable customer number used to identify the account, distinct from the id.

statusstringenumValues:normalpreferredhold_shipment

Account status code, controlling whether the customer can transact.

  • normal: standard active account with no restrictions.
  • preferred: active account flagged as preferred.
  • hold_shipment: orders can be placed, but shipments are held.
  • hold_all: all activity is on hold.
edi_statusstringenumValues:enableddisabled

Whether EDI (Electronic Data Interchange) is enabled for exchanging orders and documents with this customer.

relationship_typestringenumValues:standaloneparentchild

The customer's position in the account hierarchy.

  • standalone: no parent or child accounts.
  • parent: has one or more child accounts (see child_accounts).
  • child: belongs to a parent account (see parent_account).
commission_policystringenumValues:commission_appliedcommission_exempt

How sales commission applies to this customer's orders.

  • commission_exempt: this customer's orders are exempt from sales commission.
  • commission_applied: sales commission is calculated on this customer's orders.
notestringnullable

Free-form note about the customer.

credit_limitobjectnullable

Maximum credit extended to this customer.

Always returned as null in this endpoint.
contact_infoobjectnullable

Contact information.

Always returned as null in this endpoint.
freight_preferencesobjectnullable

Freight and carrier preferences applied to this customer's shipments.

Always returned as null in this endpoint.
defaultsobjectnullable

Default settings applied to new orders for this customer.

Always returned as null in this endpoint.
notification_preferencesobjectnullable

Notification preferences.

Always returned as null in this endpoint.
bill_to_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.
ship_to_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.
typeobjectnullable

The account group of type type_group that categorizes this customer (for example "Distributors").

Always returned as null in this endpoint.
price_groupsobjectnullable

Account groups of type pricing_group that this customer belongs to, used to apply pricing rules.

Always returned as null in this endpoint.
parent_accountobjectnullable

Parent account.

Present if this is a child account.

Always returned as null in this endpoint.
child_accountsobjectnullable

Child accounts.

Present if this is a parent account.

Always returned as null in this endpoint.
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.

Responses

200

Successful response for List Customers