latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility Note

List notes for a facility credentialing workflow

Returns all notes attached to the specified facility credentialing workflow. Use this for the facility workflow note thread; for practitioner workflow notes use the Note endpoints.

Preconditions: workflowId must identify an existing facility credentialing workflow.

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.

get/facility-credentialing-workflows/{workflowId}/notes

Path parameters

workflowIdstring required

ID of the facility credentialing workflow

Query parameters

endAtIdstring

Accepted for compatibility but not applied by api-layer

filterstring

Accepted for compatibility but not applied by api-layer

orderstring

Accepted for compatibility but not applied by api-layer. Results are returned in the order provided by the data layer (typically createdAt descending).

pageinteger

Accepted for compatibility but not applied by api-layer (default 1)

sizeinteger

Accepted for compatibility but not applied by api-layer (default 50)

startAfterIdstring

Accepted for compatibility but not applied by api-layer

Headers

tenant-idstring required

Tenant ID

Response

Note list for the facility workflow (newest first); list query params are not applied

totalCountinteger

Total count of notes returned for the workflow

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"
    }
  ]
}