Query workspace users

Returns workspace users that match the provided filters and pagination settings.

POST/api/users/query

Returns workspace users that match the provided filters and pagination settings.

Request Body

application/json

Request payload for Query workspace users.

TypeScript Definitions

Use the request body type in TypeScript.

query?|

Free-text search applied to workspace user fields.

filters?array<>|

Structured filters for the workspace users query.

limit?|||||

Maximum number of results to return.

offset?|||||

Number of results to skip before returning data.

Response Body

`application/json`

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

[  {    "id": "wu_123",    "workspaceId": "ws_123",    "type": "user",    "userId": "usr_123",    "externalId": "hydro:sap-sales-persons:199",    "email": "jane@example.com",    "name": "Jane Doe",    "description": "Sales manager",    "data": {},    "roles": [      "admin"    ],    "deletedAt": "2026-03-10T12:05:00.000Z",    "createdAt": "2026-03-10T12:00:00.000Z",    "updatedAt": "2026-03-10T12:05:00.000Z"  }]

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

Query workspace users

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`