Skip to main content
GET
Get clients
Retrieve the list of clients which a contact can access, including their brands and status.

Authorizations

x-api-key
string
header
required

An API Key.

Headers

Authorization
string
required

The access token.

X-Contact-ID
string

The identifier of a contact.

Query Parameters

brand
string

Filter clients by brand code (e.g., EBP, FXF)

Response

List of clients

client_id
string
required

Identifier of the client.

client_name
string
required

Name of the client.

status
enum<string>
required

Status of the client.

Available options:
Active,
Inactive,
Closed,
Blocked
brand_name
string
required

Brand name of the client.

address_line_1
string

The first address line of a client.

address_line_2
string

The second address line of a client.

city
string

The city name of a client.

client_entity_id
string

The identifier of the client's legal Ebury entity.

client_entity_name
string

The name of the client's legal Ebury entity.

client_entity_country_iso3
string

The ISO 3166-1 alpha-3 code of the client's legal Ebury entity's country.

Pattern: [A-Z]{3}
country_code
string

The ISO 3166-1 alpha-2 code of the client's country.

Pattern: [A-Z]{2}
country_name
string

The name of the client's country.

post_code
string

The post code of the client.

state_province
string

The state or province of the client.