Query customers

POST/api/customers/query

Returns customers that match a free-text query and structured filters.

Request Body

application/json

Request payload for Query customers.

limit?|||||

Maximum number of results to return.

offset?|||||

Number of results to skip before returning data.

query?|

Free-text query applied to customer records.

filters?array<>|

Structured customer filters.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/customers/query" \  -H "Content-Type: application/json" \  -d '{}'

[
  {
    "id": "cust_123",
    "workspaceId": "ws_123",
    "type": "company",
    "name": "Acme Corp",
    "email": "sales@acme.test",
    "phone": "+56 9 1234 5678",
    "address": "Av. Apoquindo 1234, Santiago",
    "createdAt": "2026-03-10T12:00:00.000Z",
    "updatedAt": "2026-03-10T12:05:00.000Z",
    "data": {
      "industry": "Construction",
      "tier": "gold"
    },
    "customFields": {
      "industry": "Construction",
      "tier": "gold"
    },
    "externalId": "crm_9981",
    "primaryMembership": {
      "id": "cm_123",
      "customerId": "cust_123",
      "personId": "person_123",
      "roles": [
        "buyer"
      ],
      "isPrimary": true,
      "isActive": true,
      "label": "Billing contact",
      "person": {
        "id": "person_123",
        "name": "Ana Torres",
        "primaryEmail": "ana@example.com",
        "emailAddresses": [
          "ana.work@example.com"
        ],
        "phoneNumbers": [
          "+56 9 1234 5678"
        ],
        "jobTitle": "Purchasing Manager"
      }
    },
    "lastOrder": {
      "id": "ord_123",
      "customerId": "cust_123",
      "number": "SO-1001",
      "workspaceId": "ws_123",
      "status": "draft",
      "data": {
        "industry": "Construction",
        "tier": "gold"
      },
      "customFields": {
        "industry": "Construction",
        "tier": "gold"
      },
      "createdAt": "2026-03-10T12:00:00.000Z",
      "updatedAt": "2026-03-10T12:05:00.000Z",
      "revision": 0
    }
  }
]

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Query customers

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`