v1

latestOpenAPI 3.0.32026-07-13149852.3 MB

customer

Customer - Get Customers

Retrieve a paginated list of customers with optional filtering.

get/customer/get_customers

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50

skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

Response

Array of customers

_idstring required

Unique customer identifier

namestring

Customer name

phonestring

Phone number

emailstring

Email address

addressobject

Customer address object

companystring

Company name

tagsstring[]

Array of tag IDs (ObjectId strings referencing the tag collection)

store_idstring

Associated store ID

price_listsstring[]

Assigned price list IDs

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "store_id": "507f1f77bcf86cd799439011"
  }
]