developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

User APICustomers

Get Customer list by tenant

gethttps://user-api.ancon.io/public/api/v1.1/Tenants/{tenantId}/Customers
View .mdOpenAPI

Filtering

Filter the list with filter[field]=operator:value; see how filtering works.

Show all 14 filter fields
  • name (string)
  • firstname (string)
  • lastname (string)
  • created (datetime)
  • email (string)
  • firstorder (datetime)
  • lastorder (datetime)
  • totalonlineorders (int)
  • totalposorders (int)
  • totalspent (decimal)
  • outletid (guid)
  • tenantid (guid)
  • ordersonoutlets (guid)
  • salesourceid (nullable guid)

Try filters

Build a filter for this endpoint and copy the request. How filtering works

Filters

Documented filter fields

Reads asNo filters: the endpoint returns everything (paged).

Request
(no filters)

No sample data for this endpoint; the request above is what you would send.

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • tenantIdstring (uuid)required

Query parameters

  • Offsetinteger (int32)
  • Limitinteger (int32)

    min 0, max 1000.

  • Orderstring
  • Searchstring
  • Filtermap<string, array<string>>

Filter takes filter[field]=operator:value on 14 fields. Build a filter

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • itemsarray<object> | null
    14 fields in items
    • idstring (uuid)
    • createdstring (date-time)
    • firstNamestring | null
    • lastNamestring | null
    • emailstring | null
    • languageCodestring | null
    • isDeletedboolean
    • isDisabledboolean
    • totalOnlineOrdersinteger (int32)
    • totalPosOrdersinteger (int32)
    • totalSpentobject | null
      2 fields in totalSpent
      • amountnumber (double)
      • currencystring | null
    • firstOrderstring (date-time) | null
    • lastOrderstring (date-time) | null
    • saleSourceIdstring (uuid) | null
  • metaobject | null
    2 fields in meta
    • countinteger (int32)
    • offsetinteger (int32)
401Unauthorizedapplication/json
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)