Query User Alerts | Zignal Labs

Queries alerts across specified streams with filtering, pagination, and search. The authenticated user must have access to the requested streams. Any stream IDs the user does not have access to will be silently excluded.

Request

This endpoint expects an object.

streamslist of stringsRequired

Array of stream IDs to query. At least one required.

pageintegerOptional>=1Defaults to 1

Page number.

limitintegerOptional<=200Defaults to 50

Results per page.

sortBystringOptionalDefaults to createdAt

Field to sort by.

sortDirenumOptionalDefaults to -1

Sort direction. -1 for descending, 1 for ascending.

Allowed values:

viewedStatusenumOptionalDefaults to all

Filter by viewed status.

Allowed values:

textlist of stringsOptional

Search terms to filter alerts.

textConditionalenumOptionalDefaults to or

Logical operator for text search terms.

Allowed values:

datesobjectOptional

Date range filter.

Response

Successful response

Errors

400

Bad Request Error

$	curl -X POST https://api.zignallabs.com/detect/v1/alerts \
>	-H "Content-Type: application/json" \
>	-d '{
>	"streams": [
>	"683a1b2c3d4e5f6a7b8c9d0e"
>	],
>	"page": 1,
>	"limit": 50,
>	"sortBy": "createdAt",
>	"sortDir": -1,
>	"viewedStatus": "all",
>	"dates": {
>	"startDateTime": "2026-05-11T00:00:00Z",
>	"endDateTime": "2026-05-18T00:00:00Z"
>	}
>	}'