DRdrivewealth
User Notes

List User Notes

Retrieves a paginated list of notes attached to a user, most recent first. External (partner) callers never see INTERNAL-visibility notes.

get/users/{userID}/notes

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/users/{userID}/notes
  • Auth
    HTTP bearer

Path parameters

userIDstring required

sensitive The User's unique identifier.

Query parameters

visibility'INTERNAL' | 'EXTERNAL'

INTERNAL notes are visible only within DriveWealth; EXTERNAL notes are also visible to the partner.

Filter by note visibility. Only a DriveWealth-internal caller may request INTERNAL; a partner-originated request for INTERNAL is rejected with 403.

category'USERS' | 'ACCOUNTS' | 'ORDERS' | 'ACATS' | 'KYC' | 'CORPORATE_ACTIONS' | 'INSTRUMENTS' | 'PAYMENTS' | 'TRANSACTIONS' | 'TAX' | 'STATEMENTS' | 'SUBSCRIPTIONS' | 'PORTFOLIO' | 'GFV' | 'FPSL' | 'POSITIONS' | 'PDT' | 'TEFRA' | 'OTHER'

The area of the business a note relates to.

Filter by note category.

limitinteger

The number of notes to return per page. Minimum=1, Maximum=100.

offsetstring

Pagination cursor - the id of a note from a previous page's response. Omit to start from the beginning.

direction'next' | 'prev'

Pagination direction relative to offset.

fromstring date-time

Start of a created date range filter. Must be supplied together with to.

tostring date-time

End of a created date range filter. Must be supplied together with from, and must be after it.

Response

Retrieving the User's notes was successful.

idstring required

The note's unique identifier.

createdstring date-time

When the note was created.

subjectstring
notestring

sensitive

createdBystring

sensitive The username of whoever created the note.

category'USERS' | 'ACCOUNTS' | 'ORDERS' | 'ACATS' | 'KYC' | 'CORPORATE_ACTIONS' | 'INSTRUMENTS' | 'PAYMENTS' | 'TRANSACTIONS' | 'TAX' | 'STATEMENTS' | 'SUBSCRIPTIONS' | 'PORTFOLIO' | 'GFV' | 'FPSL' | 'POSITIONS' | 'PDT' | 'TEFRA' | 'OTHER'

The area of the business a note relates to.

visibility'INTERNAL' | 'EXTERNAL'

INTERNAL notes are visible only within DriveWealth; EXTERNAL notes are also visible to the partner.

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-000000000165",
    "created": "2026-06-15T14:22:01.000Z",
    "subject": "Called client re: KYC docs",
    "note": "Client confirmed documents will be uploaded by Friday.",
    "createdBy": "jsmith",
    "partner": {
      "id": "123e4567-e89b-12d3-a456-000000000005",
      "name": "Acme Brokerage"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.