Query product lists

POST/api/product-lists/query

Returns saved product lists visible to the current workspace user.

Request Body

application/json

Request payload for Query product lists.

TypeScript Definitions

Use the request body type in TypeScript.

query?|

Optional search query for product lists.

showOnlyMyLists?|

Whether to only return lists created by the current user.

limit?|

Maximum number of results to return.

prioritizeMyLists?|

Whether lists created by the current user should be ordered first.

Response Body

`application/json`

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

[  {    "id": "list_123",    "name": "Fertilizers",    "data": {      "items": [        {          "productId": "product_123",          "quantity": 0,          "unitCode": "unit"        }      ],      "note": "Summer bundle",      "imageFileId": "file_123"    },    "visibility": "organisation",    "createdBy": "workspace_user_123",    "workspaceId": "ws_123",    "createdAt": "2026-03-20T12:00:00.000Z",    "updatedAt": "2026-03-20T12:05:00.000Z",    "imageUrl": "https://files.recerc.test/file_123"  }]

{  "_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`