Skip to content
Steward Developers
Back to Steward

List notes for a parent entity

GET
/api/v1/notes

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
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.

entityType
required
string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION

Type of parent entity whose notes you want to list

entityId
required
string
Example
507f1f77bcf86cd799439011

ID of the parent entity

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Notes retrieved successfully

object
items
required
Array<object>
object
id
required

Note ID

string
Example
507f1f77bcf86cd799439011
content
required

Content of the note

string
Example
Applicant confirmed ownership structure during call
attachments
required

File attachments

Array<object>
object
key
required

S3 key of the attachment

string
Example
uploads/uuid_document.pdf
fileName
required

Original file name

string
Example
document.pdf
contentType
required

MIME type of the file

string
Example
application/pdf
fileUrl
required

URL to access the file

string
Example
https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf
createdBy
required

ID of the user who created the note

string
Example
60d5ecb54b24003a7c8e92b2
updatedBy

ID of the user who last updated the note

string
Example
60d5ecb54b24003a7c8e92b2
createdByUser
required

User who created the note

object
firstName
required

First name of the user

string
Example
John
lastName
required

Last name of the user

string
Example
Smith
email
required

Email address of the user

string
Example
john.smith@example.com
updatedByUser

User who last updated the note

object
firstName
required

First name of the user

string
Example
John
lastName
required

Last name of the user

string
Example
Smith
email
required

Email address of the user

string
Example
john.smith@example.com
createdAt
required

Date the note was created

string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required

Date the note was last updated

string format: date-time
Example
2026-03-30T12:00:00.000Z
nextCursor
required
string
nullable
Example
ZGVzY3xjcmVhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQ
Example
{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "content": "Applicant confirmed ownership structure during call",
      "attachments": [],
      "createdBy": "60d5ecb54b24003a7c8e92b2",
      "updatedBy": "60d5ecb54b24003a7c8e92b2",
      "createdByUser": {},
      "updatedByUser": {},
      "createdAt": "2026-03-30T12:00:00.000Z",
      "updatedAt": "2026-03-30T12:00:00.000Z"
    }
  ],
  "nextCursor": "ZGVzY3xjcmVhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMQ"
}

404

Section titled “404 ”

Parent entity not found