Returns a list of master and investment accounts created on the B2COPY investment platform. Filter by account, client email, or type, and page through results.
Endpoint
GET [host]/api/v2/b2copy/accountsAuthentication
Send the access token in the Authorization: Bearer <access_token> header — see Authorization in the Back Office.
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| investmentPlatformId | integer | Yes | The investment platform instance. Use 1 for a single connected MT server; contact Support if you have several. |
| account_number | string | No | MT login of a specific master or investment account. |
| string | No | Client email — returns accounts of that client. | |
| is_master | boolean | No | true → only master accounts; false → only investment accounts. |
| limit | integer | No | Maximum number of items returned. |
| offset | integer | No | Skip the first N items. |
| sort_by | string | No | Sort field. Supported: created_at. |
| sort_order | string | No | Sort direction: asc or desc. |
curl --location --request GET 'https://host.name/api/v2/b2copy/accounts' \
--header 'Authorization: Bearer <access_token>' \
--data-raw '{
"investment_platform_id": 1,
"account_number": "2121944013",
"email": "username@example.com",
"is_master": true,
"limit": 100,
"offset": 0,
"sort_by": "created_at",
"sort_order": "asc"
}'Response
An array of objects describing the matching accounts.
{
"firstName": "John",
"lastName": "Smith",
"email": "username@example.com",
"account_id": "2121944013",
"group": "demo_standalone",
"account_type": "master",
"createdAt": "2024-02-09T10:32:47.000000Z"
}