v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

MonitoringWorkflow

Get monitoring workflows

Retrieves a list of monitoring workflows based on filter criteria

get/monitoring-workflows

Query parameters

endAtIdstring

End at document ID, for backward cursor-based pagination

filterstring

Filter criteria as JSON object (URL encoded)

orderstring

Sort order specification

pageinteger

Page number (0-based), for offset-based pagination

sizeinteger

Page size

startAfterIdstring

Start after document ID, for forward cursor-based pagination

Headers

tenant-idstring required

Tenant ID

Response

Successfully retrieved monitoring workflows

totalCountinteger

Total count of monitoring workflows

Example response

{
  "totalCount": 100,
  "data": [
    {
      "id": "1234",
      "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
    }
  ]
}