Sign in
Customers

List customers

Returns a paginated list of customers. Supports optional full-text search by first or last name.

get/customers

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/customers
  • Auth: none declared

Query parameters

pagestring

Page number (1-based)

limitstring

Number of items per page (max 100)

searchstring

Filter customers by first or last name prefix (case-insensitive)

Response

Paginated list of customers

Example response

{
  "data": [
    {
      "id": 1,
      "first_name": "Maida",
      "last_name": "Dach",
      "email": "forestraynor@bauch.io",
      "phone": "8082482608",
      "customer_type": "BUSINESS",
      "_links": {
        "orders": "http://localhost:3000/transportation-orders?customer_id=1"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.