Skip to content
Back to Steward

List every note tied to an application

GET
/api/v1/notes/application/{applicationId}

Returns the application’s own notes together with the notes on its documents and screening hits, newest first. Each row carries entityType plus sourceLabel / sourceLinkId so a client can label the note’s source and link back to it. Filter with entityTypes.

applicationId
required
string

Application ID

cursor
string
Example
ZGVzY3x1cGRhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQ

Opaque cursor from a previous response’s nextCursor. Omit on the first page. Cursors are tied to a sort direction: changing order mid-pagination is rejected.

limit
number
default: 50 >= 1 <= 100

Items per page (1-100). Default 50.

order
string
default: desc
Allowed values: asc desc

Sort direction (with id as tiebreaker). Default desc (newest first). The column being sorted is endpoint-specific. See the individual endpoint docs.

entityTypes
Array<string>
Allowed values: APPLICATION DOCUMENT SCREENING_HIT AUDIT_LOG

Restrict the feed to notes whose parent is one of these entity types. Repeat the parameter or pass a comma-separated list. Omit for all of them.

Notes retrieved successfully

Media type application/json
object
items
required
Array<object>
object
id
required

Note ID

string
entityType
required

Type of parent entity this note belongs to

string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION AUDIT_LOG
entityId
required

ID of the parent entity

string
content
required

Content of the note

string
attachments
required

File attachments

Array<object>
object
key
required

S3 key of the attachment

string
fileName
required

Original file name

string
contentType
required

MIME type of the file

string
fileUrl
required

URL to access the file

string
createdBy
required

ID of the user who created the note

string
updatedBy

ID of the user who last updated the note

string
createdByUser
required

User who created the note

object
firstName
required

First name of the user

string
lastName
required

Last name of the user

string
email
required

Email address of the user

string
updatedByUser

User who last updated the note

object
firstName
required

First name of the user

string
lastName
required

Last name of the user

string
email
required

Email address of the user

string
createdAt
required

Date the note was created

string format: date-time
updatedAt
required

Date the note was last updated

string format: date-time
stewardOnly
required

True when the note was written as Steward-only and stays off the client feed. Customer writes cannot set it.

boolean
sourceLabel

Label for the parent entity, for cross-entity listings that render notes from several sources in one feed. The document file name for DOCUMENT notes, “Screening” for SCREENING_HIT notes, the annotated event headline for AUDIT_LOG notes, null for APPLICATION notes. Only populated by the by-application listing.

string
nullable
sourceLinkId

ID the client needs to navigate back to the note’s source. The document ID for DOCUMENT notes; for SCREENING_HIT notes the screened entity (individual or business) ID, which is what the Screening tab keys its deep link on, not the hit ID; for AUDIT_LOG notes the audit entry ID, which the Audit Log tab opens off ?auditLogId=. Null for APPLICATION notes. Only populated by the by-application listing.

string
nullable
nextCursor
required
string
nullable
Example
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"entityType": "APPLICATION",
"entityId": "507f1f77bcf86cd799439011",
"content": "Applicant confirmed ownership structure during call",
"attachments": [
{
"key": "uploads/uuid_document.pdf",
"fileName": "document.pdf",
"contentType": "application/pdf",
"fileUrl": "https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf"
}
],
"createdBy": "60d5ecb54b24003a7c8e92b2",
"updatedBy": "60d5ecb54b24003a7c8e92b2",
"createdByUser": {
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com"
},
"updatedByUser": {
"firstName": "John",
"lastName": "Smith",
"email": "john.smith@example.com"
},
"createdAt": "2026-03-30T12:00:00.000Z",
"updatedAt": "2026-03-30T12:00:00.000Z",
"stewardOnly": false,
"sourceLabel": null,
"sourceLinkId": null
}
],
"nextCursor": "ZGVzY3xjcmVhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQ"
}

Application not found