Get contacts

curl --request GET \
  --url https://{environment}.ebury.io/contacts \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://{environment}.ebury.io/contacts"

headers = {
    "Authorization": "<authorization>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'x-api-key': '<api-key>'}
};

fetch('https://{environment}.ebury.io/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{environment}.ebury.io/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{environment}.ebury.io/contacts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "email_address": "jsmith@example.com",
    "contact_id": "<string>",
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "country_name": "<string>",
    "first_name": "<string>",
    "home_contact_number": "<string>",
    "last_name": "<string>",
    "mobile_contact_number": "<string>",
    "name": "<string>",
    "password_reset_required": true,
    "post_code": "<string>",
    "work_contact_number": "<string>",
    "can_authorise_payments": true,
    "can_make_same_currency_payments": true,
    "can_manage_beneficiaries": true,
    "can_manage_beneficiaries_groups": true,
    "can_manage_contacts": true,
    "can_manage_fix_forwards": true,
    "can_manage_multipayments": true,
    "can_manage_payments": true,
    "can_manage_permissions": true,
    "can_trade": true,
    "can_make_independent_payments": true,
    "can_drawdown": true,
    "can_get_paid": true,
    "can_manage_third_parties": true,
    "can_authorize_payment_lvl_1": true,
    "can_authorize_payment_lvl_2": true,
    "can_authorize_payment_lvl_3": true,
    "can_authorize_payment_lvl_4": true,
    "can_trade_finance": true,
    "can_select_multipayment_delivery_date": true,
    "can_manage_trade_finance_permissions": true,
    "can_create_card_topup": true,
    "can_create_card_offload": true,
    "has_online_access": true,
    "language": "<string>",
    "locale": "<string>",
    "time_zone": "<string>"
  }
]

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

GET

contacts

Get contacts

curl --request GET \
  --url https://{environment}.ebury.io/contacts \
  --header 'Authorization: <authorization>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://{environment}.ebury.io/contacts"

headers = {
    "Authorization": "<authorization>",
    "x-api-key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: '<authorization>', 'x-api-key': '<api-key>'}
};

fetch('https://{environment}.ebury.io/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{environment}.ebury.io/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{environment}.ebury.io/contacts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{environment}.ebury.io/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "email_address": "jsmith@example.com",
    "contact_id": "<string>",
    "address_line_1": "<string>",
    "address_line_2": "<string>",
    "city": "<string>",
    "country_code": "<string>",
    "country_name": "<string>",
    "first_name": "<string>",
    "home_contact_number": "<string>",
    "last_name": "<string>",
    "mobile_contact_number": "<string>",
    "name": "<string>",
    "password_reset_required": true,
    "post_code": "<string>",
    "work_contact_number": "<string>",
    "can_authorise_payments": true,
    "can_make_same_currency_payments": true,
    "can_manage_beneficiaries": true,
    "can_manage_beneficiaries_groups": true,
    "can_manage_contacts": true,
    "can_manage_fix_forwards": true,
    "can_manage_multipayments": true,
    "can_manage_payments": true,
    "can_manage_permissions": true,
    "can_trade": true,
    "can_make_independent_payments": true,
    "can_drawdown": true,
    "can_get_paid": true,
    "can_manage_third_parties": true,
    "can_authorize_payment_lvl_1": true,
    "can_authorize_payment_lvl_2": true,
    "can_authorize_payment_lvl_3": true,
    "can_authorize_payment_lvl_4": true,
    "can_trade_finance": true,
    "can_select_multipayment_delivery_date": true,
    "can_manage_trade_finance_permissions": true,
    "can_create_card_topup": true,
    "can_create_card_offload": true,
    "has_online_access": true,
    "language": "<string>",
    "locale": "<string>",
    "time_zone": "<string>"
  }
]

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "details": "<string>",
  "message": "<string>"
}

Get all contacts for a given client.

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

client_id

string

required

The identifier of a client.

Response

List of contacts.

email_address

string<email>

required

The email address of a contact.

contact_id

string

required

The identifier of the contact.

address_line_1

string

The first address line of a contact.

address_line_2

string

The second address line of a contact.

city

string

The city name of a contact.

country_code

string

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

Pattern: [A-Z]{2}

country_name

string

The name of the contact's country.

first_name

string

The first name of the contact.

home_contact_number

string

The home contact number of a contact.

last_name

string

The last name of the contact.

mobile_contact_number

string

The mobile contact number of a contact.

name

string

The full name of a contact.

password_reset_required

boolean

True if contact needs to reset his password, False otherwise.

post_code

string

The post code of the contact.

work_contact_number

string

The work contact number of a contact.

can_authorise_payments

boolean

True if contact can authorise payments, False otherwise.

can_make_same_currency_payments

boolean

True if contact can create trades and assign same currency payments, False otherwise.

can_manage_beneficiaries

boolean

True if contact can manage beneficiaries, False otherwise.

can_manage_beneficiaries_groups

boolean

True if can manage beneficiaries groups, False otherwise.

can_manage_contacts

boolean

True if contact can manage contacts, False otherwise.

can_manage_fix_forwards

boolean

True if contact can manage fixed forwards, False otherwise.

can_manage_multipayments

boolean

True if contact can manage multipayments, False otherwise.

can_manage_payments

boolean

True if contact can manage payments, False otherwise.

can_manage_permissions

boolean

True if contact can manage permissions, False otherwise.

can_trade

boolean

True if contact can execute trades, False otherwise.

can_make_independent_payments

boolean

True if contact can make independent payments, False otherwise.

can_drawdown

boolean

True if contact can create drawdowns, False otherwise.

can_get_paid

boolean

True if contact can see/create get paid requests, False otherwise.

can_manage_third_parties

boolean

True if contact can manage third parties, False otherwise.

can_authorize_payment_lvl_1

boolean

True if contact can authorise payments at level 1, False otherwise.

can_authorize_payment_lvl_2

boolean

True if contact can authorise payments at level 2, False otherwise.

can_authorize_payment_lvl_3

boolean

True if contact can authorise payments at level 3, False otherwise.

can_authorize_payment_lvl_4

boolean

True if contact can authorise payments at level 4, False otherwise.

can_trade_finance

boolean

True if contact can access trade finance, False otherwise.

can_select_multipayment_delivery_date

boolean

True if contact can select delivery date in multipayments, False otherwise.

can_manage_trade_finance_permissions

boolean

True if contact can manage trade finance permissions, False otherwise.

can_create_card_topup

boolean

True if contact can create card topup transactions, False otherwise.

can_create_card_offload

boolean

True if contact can create card offload transactions, False otherwise.

has_online_access

boolean

True if contact has access to Ebury Online, False otherwise.

language

string

The ISO 639-1:2002 code of the contact's language.

Pattern: [a-z]{2}

locale

string

The ISO 639-1:2002 code of the contact's locale.

Pattern: [a-z]{2}

time_zone

string

The time zone of the contact.