List customers

Returns a list of customers with pagination and sort.

get/customers

Request

Base URL
https://api.togai.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/togaihq/apis/togai-apis/docs/customers/get.ts
A function with typed inputs. Its response is checked against the schema.

nextTokenstring

Example:eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==

pageSizenumber

Example:10

Response for list customers request

nextTokenstring

{
  "data": [
    {
      "billingAddress": "201 Boulevard, WA 53123",
      "status": "ACTIVE"
    }
  ]
}

Mar 1, 20246fb940b0dad9 Revision changes
- breaking
  the // response property's maxLength was increased from 255 to 320 for the response status
- info
  added the required property // to the response with the status
Nov 3, 2023a6c96c5ec06e Revision changes
- info
  added the optional property /// to the response with the status