Design / Note Use Cases / Retrieve Note Details

Retrieve Note Details

Overview

In this use case, we’ll walk through retrieving detailed information for a note. A note can be attached to a Financial Account, Recipient, Team Member, or transaction.

API Operation

Retrieve a Note

Steps

Send a request to the following endpoint:

GET /v1/notes/{noteId}

Include an Authorization header with your RocketKOR access token as a Bearer Token.
Use {noteId} to specify the ID of the note you want to retrieve.
Request body is not required.

Sample Response

The note details are returned. For details, see the Note object.

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

Retrieve Note Details

Overview

API Operation

Steps

Sample Response

ON THIS PAGE