Retrieve Customer

Beta

GET/v1/sales/customers/{id}

This endpoint is idempotent. Learn more

Returns a customer by ID.

idstring

Customer ID.

include[]optional arrayenumValues:bill_to_addressship_to_addresstype

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

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

Display name.

numberstring

Customer number.

statusstringenumValues:normalpreferredhold_shipment

Account status code.

edi_statusstringenumValues:enableddisabled

EDI status.

relationship_typestringenumValues:standaloneparentchild

Customer relationship type.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

notestringnullable

Note.

credit_limitobjectExpandablenullable

Credit limit.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

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

unitobjectnullable

Associated 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 preferences.

objectstringenumValues:customer_freight_preferences

Resource type identifier.

statusstringenumValues:free_freightbilled_freight

Freight policy.

carrierobjectExpandablenullable

Default carrier.

idstring

Carrier ID.

objectstringenumValues:carrier

Resource type identifier.

namestring

Display name.

codestringnullableenumValues:fedexupsusps

Carrier code.

account_numberstringnullable

Account number.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

ownerobjectnullable

Owner.

Always returned as null in this endpoint.

service_levelsobjectnullable

Service levels.

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

Display name.

service_level_tokenstring

Service level token.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

is_defaultboolean

Default service level for the carrier.

ownerobjectnullable

Owner.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

billing_typestringnullableenumValues:senderthird_party

Carrier billing type.

billing_accountstringnullable

Carrier billing account number.

defaultsobjectExpandablenullable

Default settings.

objectstringenumValues:customer_defaults

Resource type identifier.

payment_termobjectExpandablenullable

Default payment term.

idstring

Payment term ID.

objectstringenumValues:payment_term

Resource type identifier.

namestring

Display name.

statusstringenumValues:activeinactive

Payment term status.

ownerobjectnullable

Owner of this resource.

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

Display name.

typestringenumValues:free_freightflat_rate_freightcarrier_rate_freight

Shipping term type.

ownerobjectnullable

Owner.

Always returned as null in this endpoint.

flat_rateobjectnullable

Flat rate quantity, if any.

Always returned as null in this endpoint.

minimum_order_valueobjectnullable

Minimum order value quantity, if any.

Always returned as null in this endpoint.

free_shipping_service_levelsobjectnullable

Service levels that qualify for free shipping.

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.

namestring

Display name.

ownerobjectnullable

Owner of this resource.

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.

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.

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

typestringExpandableenumValues:standarddrop_ship

Address type.

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.

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

Customer type group.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policystringenumValues:free_freightbilled_freight

Freight policy.

typestringenumValues:pricing_grouptype_group

Account group type.

The type pricing_group indicates this account group is utilized for pricing rules. For example, you may have a 'Preferred' price group that receives a special discount rate. The type type_group indicates the account group is utilized to categorize a set of accounts. For example, you may have a group of accounts that are 'Consumers' or 'Distributors'.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

price_groupsobjectExpandablenullable

Pricing groups.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

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

previous_page_urlstringnullable

URL 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

Resources in this page.

idstring

Account group ID.

objectstringenumValues:account_group

Resource type identifier.

namestring

Display name.

descriptionstringnullable

Description.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

freight_policystringenumValues:free_freightbilled_freight

Freight policy.

typestringenumValues:pricing_grouptype_group

Account group type.

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

Display name.

numberstring

Customer number.

statusstringenumValues:normalpreferredhold_shipment

Account status code.

edi_statusstringenumValues:enableddisabled

EDI status.

relationship_typestringenumValues:standaloneparentchild

Customer relationship type.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

notestringnullable

Note.

credit_limitobjectnullable

Credit limit.

Always returned as null in this endpoint.

contact_infoobjectnullable

Contact information.

Always returned as null in this endpoint.

freight_preferencesobjectnullable

Freight preferences.

Always returned as null in this endpoint.

defaultsobjectnullable

Default settings.

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

Customer type group.

Always returned as null in this endpoint.

price_groupsobjectnullable

Pricing groups.

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

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

previous_page_urlstringnullable

URL 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

Resources in this page.

idstring

Customer ID.

objectstringenumValues:customer

Resource type identifier.

namestring

Display name.

numberstring

Customer number.

statusstringenumValues:normalpreferredhold_shipment

Account status code.

edi_statusstringenumValues:enableddisabled

EDI status.

relationship_typestringenumValues:standaloneparentchild

Customer relationship type.

commission_policystringenumValues:commission_appliedcommission_exempt

Commission policy.

notestringnullable

Note.

credit_limitobjectnullable

Credit limit.

Always returned as null in this endpoint.

contact_infoobjectnullable

Contact information.

Always returned as null in this endpoint.

freight_preferencesobjectnullable

Freight preferences.

Always returned as null in this endpoint.

defaultsobjectnullable

Default settings.

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

Customer type group.

Always returned as null in this endpoint.

price_groupsobjectnullable

Pricing groups.

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 Retrieve Customer

Retrieve Customer

import Augno from '@augno/sdk';

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

const customer = await client.sales.customers.retrieve('ac_0170df1ac58e4d24c66fc89f5f');

console.log(customer.id);

import Augno from '@augno/sdk';

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

const customer = await client.sales.customers.retrieve('ac_0170df1ac58e4d24c66fc89f5f');

console.log(customer.id);

200 example

{
  "id": "ac_0170df1ac58e4d24c66fc89f5f",
  "object": "customer",
  "name": "Acme Inc.",
  "number": "100042",
  "status": "normal",
  "edi_status": "disabled",
  "relationship_type": "standalone",
  "commission_policy": "commission_applied",
  "note": "Preferred customer since 2020.",
  "credit_limit": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "contact_info": {
    "object": "customer_contact_info",
    "email": "orders@acme.com",
    "phone": "555-123-4567",
    "url": "https://acme.com"
  },
  "freight_preferences": {
    "object": "customer_freight_preferences",
    "status": "billed_freight",
    "carrier": {
      "id": "cr_01784fd54c9ba197bb4e42f0e6",
      "object": "carrier",
      "name": "FedEx",
      "code": "fedex",
      "customer_portal_visibility": "visible",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "service_level": {
      "id": "crop_01cfaf03f104e90ef9680e2a30",
      "object": "service_level",
      "name": "FedEx Ground",
      "service_level_token": "fedex_ground",
      "customer_portal_visibility": "visible",
      "is_default": false,
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "billing_type": "sender",
    "billing_account": "123456789"
  },
  "defaults": {
    "object": "customer_defaults",
    "payment_term": {
      "id": "pytm_018694d6601ea771cd1b52e890",
      "object": "payment_term",
      "name": "Net 30",
      "status": "active",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "shipping_term": {
      "id": "shtm_014341ab4bb5bf94d5b6936f86",
      "object": "shipping_term",
      "name": "Prepaid",
      "type": "carrier_rate_freight",
      "owner": null,
      "free_shipping_service_levels": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "priority": {
      "id": "pi_01fc435701244bb3978bfb77ff",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "sales_rep": {
      "id": "acus_01ea9983ddb41dacc44ecf997c",
      "object": "account_user",
      "name": "John Doe",
      "email": "john@augno.com",
      "status": "active",
      "role": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "notification_preferences": {
    "object": "customer_notification_preferences",
    "accepts_invoice_emails": true
  },
  "bill_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "type": "standard",
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "ship_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "type": "standard",
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "type": {
    "id": "acgp_018e88072d1320808dc979cfac",
    "object": "account_group",
    "name": "Wholesale Customers",
    "commission_policy": "commission_applied",
    "freight_policy": "billed_freight",
    "type": "type_group",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "price_groups": {
    "object": "list",
    "page_info": {
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "acgp_018e88072d1320808dc979cfac",
        "object": "account_group",
        "name": "Wholesale Customers",
        "commission_policy": "commission_applied",
        "freight_policy": "billed_freight",
        "type": "type_group",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ac_0170df1ac58e4d24c66fc89f5f",
  "object": "customer",
  "name": "Acme Inc.",
  "number": "100042",
  "status": "normal",
  "edi_status": "disabled",
  "relationship_type": "standalone",
  "commission_policy": "commission_applied",
  "note": "Preferred customer since 2020.",
  "credit_limit": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "contact_info": {
    "object": "customer_contact_info",
    "email": "orders@acme.com",
    "phone": "555-123-4567",
    "url": "https://acme.com"
  },
  "freight_preferences": {
    "object": "customer_freight_preferences",
    "status": "billed_freight",
    "carrier": {
      "id": "cr_01784fd54c9ba197bb4e42f0e6",
      "object": "carrier",
      "name": "FedEx",
      "code": "fedex",
      "customer_portal_visibility": "visible",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "service_level": {
      "id": "crop_01cfaf03f104e90ef9680e2a30",
      "object": "service_level",
      "name": "FedEx Ground",
      "service_level_token": "fedex_ground",
      "customer_portal_visibility": "visible",
      "is_default": false,
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "billing_type": "sender",
    "billing_account": "123456789"
  },
  "defaults": {
    "object": "customer_defaults",
    "payment_term": {
      "id": "pytm_018694d6601ea771cd1b52e890",
      "object": "payment_term",
      "name": "Net 30",
      "status": "active",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "shipping_term": {
      "id": "shtm_014341ab4bb5bf94d5b6936f86",
      "object": "shipping_term",
      "name": "Prepaid",
      "type": "carrier_rate_freight",
      "owner": null,
      "free_shipping_service_levels": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "priority": {
      "id": "pi_01fc435701244bb3978bfb77ff",
      "object": "priority",
      "code": "normal",
      "name": "Normal",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "sales_rep": {
      "id": "acus_01ea9983ddb41dacc44ecf997c",
      "object": "account_user",
      "name": "John Doe",
      "email": "john@augno.com",
      "status": "active",
      "role": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  },
  "notification_preferences": {
    "object": "customer_notification_preferences",
    "accepts_invoice_emails": true
  },
  "bill_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "type": "standard",
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "ship_to_address": {
    "id": "ad_012100950cfaa34aa0e0ad7258",
    "object": "address",
    "name": "Headquarters",
    "type": "standard",
    "geolocation": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "type": {
    "id": "acgp_018e88072d1320808dc979cfac",
    "object": "account_group",
    "name": "Wholesale Customers",
    "commission_policy": "commission_applied",
    "freight_policy": "billed_freight",
    "type": "type_group",
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "price_groups": {
    "object": "list",
    "page_info": {
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "acgp_018e88072d1320808dc979cfac",
        "object": "account_group",
        "name": "Wholesale Customers",
        "commission_policy": "commission_applied",
        "freight_policy": "billed_freight",
        "type": "type_group",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Retrieve Customer

Path Parameters

Query Parameters

Returns

Responses