Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Note

Fetch a single credentialing workflow note

Retrieves a single note by its ID from the specified credentialing workflow. Use this when you already have the noteId (for example from the list endpoint).

Preconditions: noteId must identify an existing note, and the note must belong to the specified workflowId.

Returns 200 with the note. Returns 404 when the note record is not found. Returns 400 when the note exists but belongs to a different workflow.

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 404 when the note record is not found. Downstream data-layer errors (ApiException) are forwarded with their original status code and are not described here.

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

Path parameters

noteIdstring required

ID of the note

workflowIdstring required

ID of the credentialing workflow

Headers

tenant-idstring required

Tenant ID

Response

Note detail for the specified workflow

idstring

Unique identifier for the note

workflowIdstring

ID of the associated credentialing workflow

createdBystring

ID of the user who created the note

createdByNamestring

Full name of the user who created the note

updatedBystring

ID of the user who last updated the note

updatedByNamestring

Full name of the user who last updated the note

createdAtstring date-time
updatedAtstring date-time

Example response

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