latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

List pipeline runs for a credentialing workflow

Returns a paginated list of pipeline runs associated with the credentialing workflow identified by workflowId. Requires JWT permission CREDENTIALING_WORKFLOW_PIPELINE_TRIGGER. A pipeline run represents a single execution of an automated data verification or enrichment pipeline (e.g. NPDB query) against the workflow. Supports optional filter (JSON object with field/operator pairs, e.g. {"createdAt":{"gte":"2023-01-01T00:00:00Z"}}), order (JSON object, e.g. {"createdAt":"desc"}), and offset-based page/size pagination. Set includeSteps to true to embed individual pipeline step detail in each run object.

get/credentialing-workflows/{workflowId}/pipeline-runs

Path parameters

workflowIdstring required

ID of the credentialing workflow

Query parameters

endAtIdstring

End at document ID, for backward cursor-based pagination

filterstring

Filter criteria. Example: {"createdAt":{"gte":"2023-01-01T00:00:00Z"}}

includeStepsboolean

Whether to include pipeline steps in the response

orderstring

Sort order. Example: {"createdAt":"desc"}

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 pipeline runs

totalCountinteger

Total count of pipeline runs matching the filter criteria

Example response

{
  "totalCount": 100
}