563848e0ecc0
List monitoring workflows with filtering and pagination
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.
Query parameters
End at this document ID for backward cursor-based pagination. Ignored if startAfterId is also supplied.
Filter criteria as a URL-encoded JSON object mapping field paths to an operator (eq, neq, gt, gte, lt, lte, in, nin, contains), e.g. {"data.monitoringStatus":{"eq":"IN_PROGRESS"}}. Omit to return all workflows for the tenant.
JSON sort specification, e.g. {"createdAt":"desc"}.
Page number (0-based) for offset-based pagination. Ignored if startAfterId or endAtId is supplied.
Page size (default 50) for either pagination mode.
Start after this document ID for forward cursor-based pagination. Supplying this switches to cursor-based pagination and takes precedence over endAtId.
Headers
Tenant ID
Response
Pagination envelope: totalCount (total workflows matching the filter) and data (array of monitoring workflow records for the current page).
Example response
{
"totalCount": 100,
"data": [
{
"id": "44c8fa75-15a1-4790-a0dd-139058d1f86d",
"tenantId": "tenant_123456",
"tenantPractitionerId": "tp_123456",
"certifyPractitionerId": "cp_123456",
"data": {
"monitoringStatus": "IN_PROGRESS",
"monitoringStatusLastUpdatedDate": "2024-01-15T10:30:00Z"
},
"createdBy": "user_123456",
"updatedBy": "user_123456",
"createdAt": "2022-03-10T16:15:50Z",
"updatedAt": "2022-03-10T16:15:50Z",
"allFlagsCount": 5
}
]
}