/v2/accounts/find

GET

Get sub-accounts owned by the authenticating user. Optionally filter by account status and other criteria.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required
NameInTypeDescriptionEnumDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumDefault
account_name query string Account name.
brand query string The value of this field is used for white labeling the Currencycloud user interface.
your_reference query string User-generated reference code.
status query string Account status. enabled
enabled_no_trading
disabled
street query string First line of address.
city query string City.
state_or_province query string State or province.
postal_code query string Postal code.
country query string Two-letter country code.
spread_table query string The name of the spread table assigned to the account.
page query integer Page number.
per_page query integer Number of results per page.
order query string Any field name to change the sort order.
order_asc_desc query string Sort records in ascending or descending order. asc
desc
asc
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/accounts/find

Response

{
    "accounts": [
        {
            "id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "12 Steward Street",
            "city": "London",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "E1 6FQ",
            "spread_table": "no_markup",
            "legal_entity_type": "company",
            "created_at": "2018-04-18T12:30:37+00:00",
            "updated_at": "2018-10-17T09:40:42+00:00",
            "identification_type": "incorporation_number",
            "identification_value": "123456789",
            "short_reference": "180418-00003",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T15:05:01+00:00",
            "updated_at": "2018-04-26T15:05:01+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00018",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "account_name": "Test Sub Account",
            "brand": "currencycloud",
            "your_reference": "",
            "status": "enabled",
            "street": "2 London St",
            "city": "London",
            "state_or_province": "City of London",
            "country": "GB",
            "postal_code": "AB1 2CD",
            "spread_table": "flat_0.25%",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T15:42:01+00:00",
            "updated_at": "2018-04-26T15:42:01+00:00",
            "identification_type": "incorporation_number",
            "identification_value": "1234567",
            "short_reference": "180426-00024",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "e514c9ba-3524-4882-9eca-d79b44756d33",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T18:28:57+00:00",
            "updated_at": "2018-04-26T18:28:57+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00027",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "34353af0-1f6a-49c5-9cd6-8007b09b4efb",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T18:47:11+00:00",
            "updated_at": "2018-04-26T18:47:11+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00028",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "cc053753-3b41-44d1-93d1-a0650dc8ec1a",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T18:50:14+00:00",
            "updated_at": "2018-04-26T18:50:14+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00029",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "d09017b3-4c55-4fd5-abff-689df3d50971",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T19:01:17+00:00",
            "updated_at": "2018-04-26T19:01:17+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00030",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "d55f2b22-8a31-4fe9-83cb-8b5dd6f1d209",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T19:10:54+00:00",
            "updated_at": "2018-04-26T19:10:54+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00031",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "0dea83b1-194a-49e6-9121-31fbd845e5e1",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-26T19:16:33+00:00",
            "updated_at": "2018-04-26T19:16:33+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180426-00032",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "175ab36b-5fc8-4f99-bf2e-0d25466a454f",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T07:02:58+00:00",
            "updated_at": "2018-04-27T07:02:58+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00007",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "fafe9390-23e6-4800-8925-da8edffe3aba",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T10:07:31+00:00",
            "updated_at": "2018-04-27T10:07:31+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00011",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "5d2bd175-9091-47bf-8872-f9c25699f930",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T10:39:27+00:00",
            "updated_at": "2018-04-27T10:39:27+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00012",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "cd4173fe-bc9c-4016-a01f-7883d9354dff",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T10:45:20+00:00",
            "updated_at": "2018-04-27T10:45:20+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00013",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "52220286-e7db-4ca9-960f-b18f59696c6a",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T10:49:14+00:00",
            "updated_at": "2018-04-27T10:49:14+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00014",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "e05da15b-512b-4462-84e7-729f53108d15",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T10:55:42+00:00",
            "updated_at": "2018-04-27T10:55:42+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00015",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "6bc9b249-4e28-4928-a913-fbf954f659e4",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T10:57:54+00:00",
            "updated_at": "2018-04-27T10:57:54+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00016",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "db872306-05c9-4a39-a90c-09c736dde018",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T11:00:21+00:00",
            "updated_at": "2018-04-27T11:00:21+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00017",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "6c2ec4fc-f825-438b-bb77-e7696de6fc4c",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T13:04:33+00:00",
            "updated_at": "2018-04-27T13:04:33+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00018",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "fa76aade-25f5-4100-9bf4-601a0ecea105",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T13:57:27+00:00",
            "updated_at": "2018-04-27T13:57:27+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00019",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "e41b686b-cc98-4364-bed5-30b3ae9bf77e",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T14:16:04+00:00",
            "updated_at": "2018-04-27T14:16:04+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00020",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "d25d84b2-ac72-41c5-8afc-c367fff6ffa5",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-27T15:28:00+00:00",
            "updated_at": "2018-04-27T15:28:00+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180427-00022",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "8991bbc7-50e1-41f1-be5e-96b4ef43f7d9",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-30T11:33:53+00:00",
            "updated_at": "2018-04-30T11:33:53+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180430-00002",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "51b67ff1-f93a-4c66-96fa-a574be60e69a",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-30T14:24:52+00:00",
            "updated_at": "2018-04-30T14:24:52+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180430-00005",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "74e5c8d8-9d0e-4951-bbca-060c8f881b83",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-04-30T15:01:38+00:00",
            "updated_at": "2018-04-30T15:01:38+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180430-00008",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        },
        {
            "id": "5d9f7e4b-9dc9-4241-a43b-5a21d0e93a8b",
            "account_name": "My Example Account",
            "brand": "currencycloud",
            "your_reference": null,
            "status": "enabled",
            "street": "My Example Street",
            "city": "My Example City",
            "state_or_province": null,
            "country": "GB",
            "postal_code": "Example Code",
            "spread_table": "fxcg_rfx_default",
            "legal_entity_type": "company",
            "created_at": "2018-05-01T11:05:27+00:00",
            "updated_at": "2018-05-01T11:05:27+00:00",
            "identification_type": null,
            "identification_value": null,
            "short_reference": "180501-00006",
            "api_trading": true,
            "online_trading": true,
            "phone_trading": true,
            "process_third_party_funds": false,
            "settlement_type": "net"
        }
    ],
    "pagination": {
        "total_entries": 303,
        "total_pages": 13,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 account_name_is_too_short account_name can not be shorter than 1 character(s) { "minlength" => 1 }
account_name_is_too_long account_name can not be longer than 150 character(s) { "maxlength" => 255 }
brand_is_too_short brand can not be shorter than 1 character(s) { "minlength" => 1 }
brand_is_too_long brand can not be longer than 100 character(s) { "maxlength" => 255 }
your_reference_is_too_short your_reference can not be shorter than 1 character(s) { "minlength" => 1 }
your_reference_is_too_long your_reference can not be longer than 25 character(s) { "maxlength" => 25 }
status_not_in_range status should be in range: enabled, disabled, enabled_no_trading { "range" => "enabled, disabled, enabled_no_trading" }
legal_entity_type_not_in_range legal_entity_type should be in range: individual, company { "range" => "individual, company" }
street_is_too_long street can not be longer than 150 character(s) { "maxlength" => 150 }
city_is_too_long city can not be longer than 100 character(s) { "maxlength" => 100 }
postal_code_is_too_long postal_code can not be longer than 20 character(s) { "maxlength" => 20 }
country_is_too_long country can not be longer than 2 character(s) { "maxlength" => 2 }
spread_table_is_too_short country can not be shorter than 1 character(s) { "minlength" => 1 }
spread_table_is_too_long country can not be longer than 100 character(s) { "maxlength" => 100 }
401 invalid_supplied_credentials Authentication failed with the supplied credentials
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this page helpful?
Yes
No