Skip to main content

List accounts

This endpoint returns a list of all the accounts associated with the specified user.

Account Numbers

This request will not return the full account number. It may return the last four digits of the account number if that information has been provided during aggregation. If you need the full account number, please refer to List account numbers by member or List account numbers by account.

GET
/users/{user_identifier}/accounts

Path Parameters

FieldRequiredType

user_identifier

Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You​.

Required
String

Query Parameters

FieldRequiredType

page

Results are paginated. Specify current page.

Optional
Integer

member_is_managed_by_user

List only accounts whose member is managed by the user.

Optional
Boolean

is_manual

List only accounts that were manually created.

Optional
Boolean

records_per_page

This specifies the number of records to be returned on each page. Defaults to 25. The valid range is from 10 to 1000. If the value exceeds 1000, the default value of 25 will be used instead.

Optional
Integer

use_case

The use case associated with the member. Valid values are PFM and MONEY_MOVEMENT. For example, you can append either ?use_case=PFM or ?use_case=MONEY_MOVEMENT.

Optional
String

Header Parameters

FieldRequiredType

Accept-Version

MX Platform API version.

Required
String

Accept

Specifies the media type expected in the response.

Required
String
Loading...