List customers

​

Query Parameters

  • page
    Type: integer
    min:  
    -9007199254740991
    max:  
    9007199254740991

    Page number

  • limit
    Type: integer
    min:  
    -9007199254740991
    max:  
    9007199254740991

    Items per page

  • search
    Type: string

    Free-text search

  • dateFrom
    Type: string

    Filter from date (YYYY-MM-DD; legacy MM-DD-YYYY accepted)

  • dateTo
    Type: string

    Filter to date (YYYY-MM-DD; legacy MM-DD-YYYY accepted)

  • orderBy
    Type: string

    Field used for sorting

  • orderDirection
    enum

    Sort direction

  • id
    Type: stringFormat: uuid

    Customer UUID

  • externalId
    Type: string

    Partner-defined customer identifier

  • type
    enum

    Customer type filter

  • productType
    enum

    Filter to customers enrolled in a product

  • product
    enum

    Filter to customers enrolled in a product

Responses

  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/customers
curl 'https://api-sandbox.tryslatehq.com/customers?page=1&limit=50&dateFrom=2025-01-30&dateTo=2025-01-30&orderBy=createdAt&id=123e4567-e89b-12d3-a456-426614174000&externalId=cus_123' \
  --header 'x-api-key: YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "externalId": "cus_123",
      "productType": "capital",
      "type": "BUSINESS",
      "business": {
        "legalName": "Acme Corp",
        "dba": "Acme",
        "type": "PARTNERSHIP",
        "website": "https://acme.com",
        "address": {
          "address1": "123 Main St",
          "address2": null,
          "city": "San Francisco",
          "postalCode": "94105",
          "country": "US",
          "state": "CA"
        },
        "contact": {
          "fullName": "John Doe",
          "email": "john@acme.com",
          "phone": "+15551234567"
        }
      }
    }
  ],
  "page": 1,
  "limit": 1,
  "total": 1,
  "totalPages": 1
}

OK