Web APIFIX API
API Reference
API StatusLogin

List User Notes

get
https://bo-api.drivewealth.io/back-office/users//notes

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

Path Params
string
required

The User's unique identifier.

Query Params
string
enum

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

Show Details
INTERNALVisible only to DriveWealth-internal callers.
EXTERNALVisible to DriveWealth-internal callers and the partner.
Allowed:
string
enum

Filter by note category.

Show Details
USERSRelates to the user's profile or identity.
ACCOUNTSRelates to one of the user's accounts.
ORDERSRelates to order entry or execution.
ACATSRelates to an ACATS (Automated Customer Account Transfer Service) transfer.
KYCRelates to Know Your Customer identity verification.
CORPORATE_ACTIONSRelates to a corporate action (e.g. a stock split or merger).
INSTRUMENTSRelates to a tradable instrument.
PAYMENTSRelates to a deposit, withdrawal, or other payment.
TRANSACTIONSRelates to a ledger transaction.
TAXRelates to tax reporting or withholding.
STATEMENTSRelates to an account statement.
SUBSCRIPTIONSRelates to a recurring subscription.
PORTFOLIORelates to portfolio or managed-allocation activity.
GFVRelates to a Good Faith Violation.
FPSLRelates to Fully Paid Securities Lending.
POSITIONSRelates to a held position.
PDTRelates to Pattern Day Trading status or restrictions.
TEFRARelates to TEFRA (Tax Equity and Fiscal Responsibility Act) withholding.
OTHERDoesn't fit any other category.
integer
1 to 100
Defaults to 25

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

string

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

string
enum
Defaults to next

Pagination direction relative to offset.

Allowed:
date-time

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

date-time

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

Responses

Updated about 1 hour ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 1 hour ago

Did this page help you?