v1
latestOpenAPI 3.1.02026-08-063776831.4 MBFacility Note
Get notes for a facility credentialing workflow
Retrieves a paginated list of notes for the specified facility credentialing workflow
get/facility-credentialing-workflows/{workflowId}/notes
Path parameters
workflowIdstring required
ID of the facility credentialing workflow
Query parameters
endAtIdstring
End at this note ID
filterstring
Optional filter for notes
orderstring
Sort order as JSON (e.g., '{"orderBy":"createdAt","orderByDirection":"DESC"}'). If not provided, defaults to sorting by createdAt DESC (newest first).
pageinteger
Page number (1-based)
sizeinteger
Page size
startAfterIdstring
Start after this note ID
Headers
tenant-idstring required
Tenant ID
Response
Successfully retrieved notes
Example response
{
"totalCount": 100,
"data": [
{
"id": "note_123456",
"workflowId": "cw_123456",
"data": {
"message": "This is a note message"
},
"createdBy": "user_123456",
"createdByName": "John Doe",
"updatedBy": "user_123456",
"updatedByName": "Jane Smith",
"createdAt": "2022-03-10T16:15:50Z",
"updatedAt": "2022-03-10T16:15:50Z"
}
]
}