Skip to main content

List monitoring workflows with filtering and pagination

GET 
/monitoring-workflows

Returns a paginated list of monitoring workflows for the authenticated tenant. Use this endpoint to browse or search workflows; use GET /monitoring-workflows/{id} when you already know a specific workflow ID. Supports two pagination modes: offset-based (page/size, default page 0, size 50) and cursor-based (startAfterId for forward, endAtId for backward). Supplying either cursor parameter switches the query to cursor-based pagination and overrides page/size; if both startAfterId and endAtId are supplied, startAfterId takes precedence and endAtId is ignored. Filtering is controlled by the filter query parameter, a URL-encoded JSON object mapping a field path to an operator (eq, neq, gt, gte, lt, lte, in, nin, or contains; contains is only valid on string fields), e.g. {"data.monitoringStatus":{"eq":"IN_PROGRESS"}}. The order parameter accepts a JSON sort specification, e.g. {"createdAt":"desc"}. When filter is omitted, all workflows for the tenant are returned up to the page size. Requires the MONITORING_WORKFLOW_READ permission. The tenant-id header is mandatory. For callers without the MONITORING_WORKFLOW_NEEDS_VERIFICATION_FLAG permission, flags with status needsVerification are stripped from each workflow's flag arrays — the workflows themselves are still returned.

Request​

Responses​

Pagination envelope: totalCount (total workflows matching the filter) and data (array of monitoring workflow records for the current page).