carriers5

channels5

clusters5

customer-addresses3

customers4

delivery-modalities5

delivery-types5

freight-types5

fulfillment-order-shipment-tracking-events1

fulfillment-order-shipments3

fulfillment-order-tracking-events1

fulfillment-orders4

inventory2

inventory-movements1

operators5

order-payments2

orders7

payment-methods3

permissions1

price-lists7

product-categories5

products3

promotions5

state-machines6

statuses5

strategies5

strategy-carriers5

strategy-channels5

strategy-operators5

strategy-price-lists5

webhook-subscriptions6

customers

List customers

Changed on Jul 7, 2026

Returns a paginated list of customers scoped to the caller account, with optional type and text search.

get/api/v1/customers

Request

Base URL
https://oms-api.tenant.krzlabs.io
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/kruzer-corp/apis/oms-api/docs/api/v1/customers/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

typestring

qstring

pagenumber

limitnumber

sortBystring

sortOrderstring

Response

Paginated list of customers.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Jul 7, 2026a3b4750a505f Revision changes
- info
  added the new optional query request parameter limit
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter q
- info
  added the new optional query request parameter sortBy
- info
  added the new optional query request parameter sortOrder
- info
  added the new optional query request parameter type
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
Jul 7, 202684194c31ab85 Revision changes
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- warning
  deleted the query request parameter limit
- warning
  deleted the query request parameter page
- warning
  deleted the query request parameter q
- warning
  deleted the query request parameter sortBy
- warning
  deleted the query request parameter sortOrder
- warning
  deleted the query request parameter type

Operation history