/usersList Users
Returns a paginated list of users assigned to the GMA partner.
Query parameters
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
pageNumber | integer | Optional | — | Page number (enter 1 for the first page, 2 for the second, etc.). |
pageSize | integer | Optional | 10 | 20 | 40 | 100 | Number of records to return per page. |
searchTerm | string | Optional | john.doe | Free-text search across name, email, country, currency, and counterparty type. |
statuses | string | Optional | active | pending | blocked | disabled | purged | Comma-separated list of statuses to filter by. |
Headers
| Field | Type | Required | Possible values | Description |
|---|---|---|---|---|
session-token | string | Required | — | SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header. |
Response
| Field | Type | Possible values | Description |
|---|---|---|---|
ResponseCode | integer | 200 | 201 | 204 | 301 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 503 | API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized). |
ResponseMessage | string | Success | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntity | Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome. |
ResponseData | object | Please refer to below example for response body | Paginated list of users assigned to the GMA partner. |
Example response
{
"ResponseCode": 200,
"ResponseMessage": "Success",
"ResponseData": {
"Data": [
{
"Id": "-6810677053690040496",
"AccountNumber": "****0001",
"Balance": "3689.84",
"Email": "john.doe@example.com",
"Group": "Individual",
"Name": "John Doe",
"Status": "ACTIVE",
"Username": "john.doe",
"TotalCount": 5,
"GroupInternalName": "Individuals",
"IsMainAccount": true,
"CreationDate": "2020-06-29T17:41:26.424Z"
},
{
"Id": "-6824187852572151984",
"AccountNumber": "****0003",
"Balance": "3645",
"Email": "user647@example.com",
"Group": "Business",
"Name": "BN_10644",
"Status": "ACTIVE",
"Username": "user647",
"TotalCount": 5,
"GroupInternalName": "Businesses",
"IsMainAccount": false,
"CreationDate": "2020-07-02T18:34:35.153Z"
},
{
"Id": "-113824407790112938",
"AccountNumber": "****3626",
"Balance": "252665",
"Email": "user26485@example.com",
"Group": "Business",
"Name": "BN_882799",
"Status": "ACTIVE",
"Username": "user26485",
"TotalCount": 5,
"GroupInternalName": "Businesses",
"IsMainAccount": false,
"CreationDate": "2026-04-21T10:06:18.903Z"
},
{
"Id": "3232350115346165590",
"AccountNumber": "****3665",
"Balance": "0",
"Email": "user27230@example.com",
"Group": "Business",
"Name": "BN_897376",
"Status": "ACTIVE",
"Username": "user27230",
"TotalCount": 5,
"GroupInternalName": "Businesses",
"IsMainAccount": false,
"CreationDate": "2026-05-07T09:54:15.422Z"
},
{
"Id": "2489256176830033750",
"AccountNumber": "****3673",
"Balance": "998.75",
"Email": "user27323@example.com",
"Group": "Business - Plus",
"Name": "BN_899299",
"Status": "ACTIVE",
"Username": "user27323",
"TotalCount": 5,
"GroupInternalName": "Businesses_Lite",
"IsMainAccount": false,
"CreationDate": "2026-05-11T09:00:14.322Z"
}
],
"TotalCount": 5,
"CurrentPage": 1,
"PageSize": 40
}
}Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.