List customers

Returns customers for a shop, or for a whole seller across all of its shops.

shop_id and seller_id are both optional. If the token covers exactly one shop, that shop is auto-resolved and results are scoped to it. If the token covers multiple shops belonging to a single seller, omitting both params returns customers across all of that seller’s shops. A token covering multiple sellers (or a god token) must pass shop_id or seller_id explicitly — there is no “all sellers” search.

GET/customers

Authorization

AuthorizationBearer token (JWT) · headerrequired

Query parameters

shop_idinteger

ID of the shop whose contacts to list. Optional if the token covers exactly one shop, or if seller_id is given instead.

seller_idinteger

ID of the seller whose contacts to list, across all of its shops. Only needed when shop_id is omitted and the token covers more than one shop or seller.

qstring

Full-text search across name and email.

customer_statusstring

Filter by customer account status.

Allowed:publicprivatepending

tagsstring

Comma-separated tag names.

opt_inboolean

pageinteger

min 1 · default: 1

per_pageinteger

min 1 · max 200 · default: 20

created_on_gtestring<date-time>

Contacts created on or after this ISO 8601 timestamp.

created_on_ltestring<date-time>

Contacts created on or before this ISO 8601 timestamp.

sortstring

Sort order for results.

default: "created_on_desc"

Allowed:created_on_asccreated_on_descname_ascname_desc

Responses

200

Paginated list of contacts

total_itemsinteger

per_pageinteger

pageinteger

_linksHalLinks

_classstring[]

_embeddedobject

Show properties

contactsContact[]

Show properties

Array of Contact

_linksHalLinks

idinteger

shop_idinteger

emailstring

namestring

Full name (first and last)

phone_numberstring

phone_validatedboolean

validation_methodstring

company_namestring

company_id_numberstring

Company tax/ID number (RUT, DNI, etc.), formatted

company_activity_codestring

customer_statusstring

Customer account status.

Allowed:publicprivatepending

opt_inboolean

Whether the contact has opted in to marketing emails.

sourcestring

last_logged_onstring<date-time>

last_ip_addressstring

has_passwordboolean

total_spentinteger

In cents

available_orders_countinteger

salesperson_idinteger

favorite_product_idsinteger[]

used_promotion_idsinteger[]

tagsstring[]

created_onstring<date-time>

updated_onstring<date-time>

_embeddedobject

Show properties

contact_groupobject

Present when the contact belongs to a group

addressesAddress[]

Show properties

Array of Address

streetstring

street_2string

locality_namestring

region_namestring

country_namestring

postal_codestring

403

Access denied

422

shop_id or seller_id required — the token covers more than one shop and more than one seller (or is a god token), so neither can be auto-resolved.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

shop_idqueryID of the shop whose contacts to list. Optional if the token covers exactly one shop, or if `seller_id` is given instead. seller_idqueryID of the seller whose contacts to list, across all of its shops. Only needed when `shop_id` is omitted and the token covers more than one shop or seller. qqueryFull-text search across name and email.customer_statusqueryFilter by customer account status.tagsqueryComma-separated tag names.opt_inquerypagequeryper_pagequerycreated_on_gtequeryContacts created on or after this ISO 8601 timestamp.created_on_ltequeryContacts created on or before this ISO 8601 timestamp.sortquerySort order for results.

Request

# List all customers for a shop
curl -s -H "Authorization: Bearer $BOLDER_TOKEN" \
  "https://api.onbolder.com/v2/customers?shop_id=1"

# List customers across all of a seller's shops
curl -s -H "Authorization: Bearer $BOLDER_TOKEN" \
  "https://api.onbolder.com/v2/customers?seller_id=1"

# Search by name or email
curl -s -H "Authorization: Bearer $BOLDER_TOKEN" \
  "https://api.onbolder.com/v2/customers?shop_id=1&q=jane"

curl -X GET 'https://api.onbolder.com/v2/customers' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/customers", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/customers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_class": [
    "results",
    "customers"
  ],
  "total_items": 1,
  "per_page": 20,
  "page": 1,
  "_links": {
    "self": {
      "href": "https://api.onbolder.com/v2/customers?shop_id=1"
    },
    "customers:authenticate": {
      "href": "https://api.onbolder.com/v2/customers/sessions",
      "method": "post"
    },
    "customers:reset_password": {
      "href": "https://api.onbolder.com/v2/customers/reset_password",
      "method": "post"
    }
  },
  "_embedded": {
    "items": [
      {
        "id": 3001,
        "shop_id": 1,
        "email": "jane@example.com",
        "name": "Jane Smith",
        "customer_status": "private",
        "phone_validated": false,
        "created_on": "2024-03-10T11:00:00Z",
        "_links": {
          "self": {
            "href": "https://api.onbolder.com/v2/customers/3001"
          },
          "orders": {
            "href": "https://api.onbolder.com/v2/orders?shop_id=1&contact_email=jane@example.com"
          }
        }
      }
    ]
  }
}