members

List members

Changed on

This endpoint returns an array which contains information on every member associated with a specific user.

get/users/{user_guid}/members

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/members
  • Auth
    HTTP basic

Path parameters

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Query parameters

pageinteger

Results are paginated. Specify current page.

records_per_pageinteger

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.

use_casestring

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.

Response

OK

Changes

  • e74cd2b059b5Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      api tag members added

    • info

      api tag mx_platform removed

    • info

      added the new optional query request parameter use_case

  • b904662f5441Revision changes
    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to boolean for status

    • warning

      added the new MONEY_MOVEMENT enum value to the /// response property for the response status

    • warning

      added the new PFM enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status