RocketKOR

Design  /  Note Use Cases  /  List All Notes

List All Notes

Overview

In this use case, we’ll walk through retrieving all notes attached to a Financial Account, Recipient, Team Member, or transaction.

API Operation

Steps

Send a request to the following endpoint:

GET /v1/notes

  • Include an Authorization header with your RocketKOR access token as a Bearer Token.
  • Use the entityId and entityType query parameter to retrieve notes for a specific Financial Account, Recipient, Team Member, or transaction.
  • Use the sort query parameter to sort the results.
  • Use the page and size query parameters to limit the number of results returned.
  • Request body is not required.

Sample Response

Returns a paginated response with an array of Note objects.

In the following example, all notes belonging to a Financial Account have been returned.

				
					{
  "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-09-20T22:09:31.947Z"
    },
    {...},
    {...}
  ]
}
				
			
ON THIS PAGE