Query people

Returns people rows with normalized customers and data fields for the current workspace.

POST/api/people/query

Returns people rows with normalized customers and data fields for the current workspace.

Request Body

application/json

Request payload for Query people.

TypeScript Definitions

Use the request body type in TypeScript.

limit?|||||

Maximum number of results to return.

offset?|||||

Number of results to skip before returning data.

query?|

Free-text search applied to people rows.

filters?array<>|

Structured filters for the people query.

Response Body

`application/json`

curl -X POST "https://example.com/api/people/query" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "id": "person_123",    "workspaceId": "ws_123",    "createdAt": "2026-03-20T12:00:00.000Z",    "updatedAt": "2026-03-20T12:05:00.000Z",    "externalId": "crm_123",    "data": {      "name": "Ana Torres",      "customers": [        "customer_123"      ]    },    "customFields": {      "name": "Ana Torres",      "customers": [        "customer_123"      ]    },    "name": "Ana Torres",    "primaryEmail": "ana@example.com",    "emailAddresses": [      "ana@example.com"    ],    "description": "Procurement lead",    "customers": [      "customer_123"    ],    "customerNames": [      "Acme SpA"    ],    "customerRelations": [      {        "id": "string",        "label": "string",        "contactLabel": "string"      }    ],    "addresses": [      "Av. Apoquindo 1234"    ],    "jobTitle": "Buyer",    "phoneNumbers": [      "+56 9 1234 5678"    ],    "memberships": [      {        "id": "string",        "customerId": "string",        "personId": "string",        "roles": [          "buyer"        ],        "isPrimary": true,        "isActive": true,        "label": "string",        "person": {          "id": "string",          "name": "string",          "primaryEmail": "user@example.com",          "emailAddresses": [            "string"          ],          "phoneNumbers": [            "string"          ],          "jobTitle": "string"        },        "customer": {          "id": "string",          "name": "string"        }      }    ],    "primaryMembership": {      "id": "string",      "customerId": "string",      "personId": "string",      "roles": [        "buyer"      ],      "isPrimary": true,      "isActive": true,      "label": "string",      "person": {        "id": "string",        "name": "string",        "primaryEmail": "user@example.com",        "emailAddresses": [          "string"        ],        "phoneNumbers": [          "string"        ],        "jobTitle": "string"      },      "customer": {        "id": "string",        "name": "string"      }    }  }]

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

{  "_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."}

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`