563848e0ecc0
List notes on a credentialing workflow
Returns all free-text notes attached to the specified credentialing workflow. Use this to display or audit annotations on a practitioner credentialing workflow; for facility workflow notes use the Facility Note endpoints.
Preconditions: workflowId must identify an existing workflow visible to the tenant.
Important — query parameters with no current effect: filter, page, size, startAfterId, endAtId, and order are accepted for compatibility but are not applied by api-layer (not forwarded to the data layer). Results are returned in the order provided by the data layer (typically createdAt descending).
Error behavior: If the data layer returns a 5xx error, that status code is forwarded directly to the caller. Mutating operations (POST, PUT, DELETE) normalize 5xx to 502.
Returns a GetNotesResponse with totalCount, data, and links.
Path parameters
ID of the credentialing workflow
Query parameters
Accepted for compatibility but not applied by api-layer
Accepted for compatibility but not applied by api-layer
Accepted for compatibility but not applied by api-layer. Results are returned in the order provided by the data layer (typically createdAt descending).
Accepted for compatibility but not applied by api-layer (default 1)
Accepted for compatibility but not applied by api-layer (default 50)
Accepted for compatibility but not applied by api-layer
Headers
Tenant ID
Response
Note list for the workflow (newest first); list query params are not applied
Example response
{
"totalCount": 100,
"data": [
{
"id": "44444444-4444-4444-8444-444444444444",
"workflowId": "22222222-2222-4222-8222-222222222222",
"data": {
"message": "This is a note message"
},
"createdBy": "55555555-5555-4555-8555-555555555555",
"createdByName": "Example Analyst",
"updatedBy": "55555555-5555-4555-8555-555555555555",
"updatedByName": "Example Analyst",
"createdAt": "2022-03-10T16:15:50Z",
"updatedAt": "2022-03-10T16:15:50Z"
}
]
}