Get Contact - Currencycloud API Documentation

Home > Get Contact

/v2/contacts/{id}

GET

Get a contact.

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

Name	In	Type	Description
X-Auth-Token	header	string	Authentication token.
id	path	string	Contact UUID.

curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/contacts/{id}

Response

{
    "login_id": "[email protected]",
    "id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "first_name": "Derik",
    "last_name": "Ford",
    "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "account_name": "Currency Cloud Dev Centre",
    "status": "enabled",
    "locale": "en",
    "timezone": "Europe\/London",
    "email_address": "[email protected]",
    "mobile_phone_number": null,
    "phone_number": null,
    "your_reference": null,
    "date_of_birth": null,
    "created_at": "2018-04-18T12:30:37+00:00",
    "updated_at": "2019-02-06T15:44:20+00:00"
}

Error Codes

HTTP Status	Code	Description
400	id_is_not_valid_uuid	id should be in UUID format
400	contact_not_found	Contact was not found for this id
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

/v2/contacts/{id}

GET

API parameters

Required

Response

Error Codes

Start your borderless payments journey today

Cookies