List All Notes

Retrieve all notes for an entity. Notes can be attached to a Customer, Recipient, Team Member, Financial Account, transaction, or scheduled 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.

Endpoint

GET /v1/notes

Authorization Header

Authorization: Bearer <access_token>

Query Parameters

entityId REQUIRED

string (UUID)

ID of the entity for which you want to retrieve notes. This can be a Customer, Recipient, Team Member, Financial Account, transaction, or scheduled transaction.

entityType REQUIRED

string enum, values: CUSTOMER, RECIPIENT, TEAM_MEMBER, FINANCIAL_ACCOUNT, TRANSACTION, SCHEDULED_TRANSACTION

Type of entity for which you want to retrieve notes. This can be a Customer, Recipient, Team Member, Financial Account, transaction, or scheduled transaction.

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of Note objects.

SAMPLE RESPONSE

				
					{
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "numberOfElements": 3,
  "hasNext": false,
  "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"
    },
    {...},
    {...}
  ]
}