GET members

Updated on 09 Sep 2024
1 Minute to read

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get Sub-Account Members

Returns a list of all Sub-Account members.

URL (GET)

/api/v1/members

Parameters

Key Name	Description	Required
page	List page number
size	List page size
id	Filter by account id
status	Filter by account status
username	Filter by account name
subAccountId	Filter by sub-account id

Request Body

None

Response

{
           "id": ####,
           "subAccountId": ####,
           "firstName": "",
           "lastName": "",
           "username": "",
           "memberRole": "root",
           "email": "",
           "status": "active", (can have values: Active, Deactivated, Suspended, or Locked)
           "mfa": false,
           "imageUrl": null,
           "creationDate": "2023-12-19T09:35:47.598+00:00",
           "address1": null,
           "address2": null,
           "country": null,
           "city": null,
           "state": null,
           "zip": null,
           "phone": null
},

What's Next

GET members/:id

Table of contents

Get Sub-Account Members