customer

Customer - Get Customers

Changed on

Retrieve a paginated list of customers with optional filtering.

get/customer/get_customers

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/customer/get_customers
  • Auth
    HTTP bearer

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"
  }
]

Changes

  • fa53dd949b8eRevision changes
    • breaking

      the query request parameter selector became required

    • breaking

      for the query request parameter selector, the type changed from string to object

    • info

      api operation id get_customer_get_customers was added

    • info

      for the query request parameter limit, the format was generalized from integer to no format

    • info

      for the query request parameter skip, the format was generalized from integer to no format

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e4bdf6984278Revision changes
    • breaking

      for the query request parameter sort, the type changed from number to object, and format from integer to no format