Retrieve all notes associated with a Financial Account, Recipient, Team Member, or transaction.
Use the sort query parameter to sort the results, and use the page and size query parameters to limit the number of results returned.
GET /v1/notes
Authorization: Bearer <access_token>
entityId REQUIRED
string (UUID)
ID of the entity for which you want to retrieve notes. This can be a Financial Account, Recipient Account, Team Member, or transaction.
entityType REQUIRED
string enum, values: FINANCIAL_ACCOUNT, RECIPIENT, TEAM_MEMBER, TRANSACTION
Type of entity for which you want to retrieve notes. This can be a Financial Account, Recipient Account, Team Member, or transaction.
sort
array [string]
Sort the response by any field in ascending or descending order. For details, see Sorting and Pagination. The default sort order is createdAt,DESC.
page
integer (int32)
Page number to return, based on zero-based page index.
size
integer (int32)
Maximum number of results to return per page.
None
Returns a paginated response with an array of Note objects.
SAMPLE RESPONSE
{
"totalElements": 100,
"totalPages": 50,
"number": 1,
"numberOfElements": 2,
"hasNext": true,
"content": [
{
"id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
"entityType": "FINANCIAL_ACCOUNT",
"entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
"title": "Joint Account",
"contentText": "This is a joint account.",
"contentType": "",
"externalUrl": "",
"sizeInBytes": 0,
"businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
"createdBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"createdAt": "2021-09-20T22:09:31.947Z",
"updatedBy": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "employee"
},
"updatedAt": "2021-10-20T22:09:31.947Z"
},
{...},
{...}
]
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.