/v2/contacts/find

GET

Get contacts that match search parameters.

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.
account_id query string Sub-account UUID.
first_name query string Contact first name.
last_name query string Contact last name.
email_address query string Email address.
your_reference query string User-generated reference code.
phone_number query string Phone number.
login_id query string Currencycloud login ID.
status query string Contact status. enabled
disabled
locale query string Locale code ("en", "en-US", "fr-FR").
timezone query string Timezone ("Europe/London", "America/New_York").
page query string Page number.
per_page query string 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/contacts/find

Response

{
    "contacts": [
        {
            "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": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": "",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-18T12:30:37+00:00",
            "updated_at": "2018-08-10T18:10:29+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "631245ba-1440-4dd6-915b-2b49de5a4ed2",
            "first_name": "John",
            "last_name": "Smith",
            "account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "account_name": "Test Sub Account",
            "status": "enabled",
            "locale": "",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": "123345",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-26T15:43:19+00:00",
            "updated_at": "2018-04-26T15:43:19+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "e8466c3f-0a1e-4557-a6d5-b1de5f9509cb",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-27T10:49:19+00:00",
            "updated_at": "2018-04-27T10:49:19+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "f1a6af6c-0777-4033-b725-8056a4bb68d5",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-27T10:57:59+00:00",
            "updated_at": "2018-04-27T10:57:59+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "66afdfe0-0647-462e-83cf-ac2b3b97ef7b",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-27T11:00:26+00:00",
            "updated_at": "2018-04-27T11:00:26+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "9a69c104-6a0e-423b-9866-8c7eb795d1d0",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-27T13:57:35+00:00",
            "updated_at": "2018-04-27T13:57:35+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "84dc40f4-0780-42e6-87b2-f7c3b7284ff0",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-27T15:28:10+00:00",
            "updated_at": "2018-04-27T15:28:10+00:00"
        },
        {
            "login_id": "t[email protected]",
            "id": "2ad6d673-3cbf-4419-ad3f-fedc7c94c82b",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-30T11:34:00+00:00",
            "updated_at": "2018-04-30T11:34:00+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "bcc44f6f-9f14-4df7-8437-d69b1001f4e0",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-30T14:24:56+00:00",
            "updated_at": "2018-04-30T14:24:56+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "3835de64-1f72-47fa-b264-fb11931870dc",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-04-30T15:01:42+00:00",
            "updated_at": "2018-04-30T15:01:42+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "2b4c7ac6-28d4-4924-a4ac-12efe6a473c0",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-01T11:05:31+00:00",
            "updated_at": "2018-05-01T11:05:31+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "40df2b04-96b4-49bd-b5ba-7b8bdf8eb072",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-02T09:59:48+00:00",
            "updated_at": "2018-05-02T09:59:48+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "012058e5-a372-4947-8b5d-85e92ba674f0",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-03T09:29:07+00:00",
            "updated_at": "2018-05-03T09:29:07+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "a511fdcf-e05a-4582-9197-28b17a5a1a75",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-04T08:47:26+00:00",
            "updated_at": "2018-05-04T08:47:26+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "f151ed0b-7ca8-4347-8c89-cd790586dd5d",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-10T12:10:24+00:00",
            "updated_at": "2018-05-10T12:10:24+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "d34c13a1-07f1-44bc-b25f-a96d72d8453a",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-14T14:18:34+00:00",
            "updated_at": "2018-05-14T14:18:34+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "79cfbe86-1b01-4cc8-ade0-85298482f27a",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-16T12:38:22+00:00",
            "updated_at": "2018-05-16T12:38:22+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "2a1bb0e6-6ebf-4c0b-97cd-7bbaddd25687",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-16T12:51:12+00:00",
            "updated_at": "2018-05-16T12:51:12+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "7a003af5-c67b-45f0-a448-1f4ce02abd87",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-16T13:37:06+00:00",
            "updated_at": "2018-05-16T13:37:06+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "5b235298-c836-4f94-a521-d48002a00f5a",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-17T09:15:18+00:00",
            "updated_at": "2018-05-17T09:15:18+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "b179f78f-9df3-4166-84d6-37946229c4ac",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-21T13:37:33+00:00",
            "updated_at": "2018-05-21T13:37:33+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "7e700754-5ef1-4dcb-846d-29bbff1b50d2",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-05-23T12:44:41+00:00",
            "updated_at": "2018-05-23T12:44:41+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "70ffe9c4-7e40-4658-a8e6-82d99472d7af",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-06-19T15:24:12+00:00",
            "updated_at": "2018-06-19T15:24:12+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "a91a565a-e1c2-4870-be0c-4c000f776ee0",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-06-19T15:55:12+00:00",
            "updated_at": "2018-06-19T15:55:12+00:00"
        },
        {
            "login_id": "[email protected]",
            "id": "40aea74b-fae0-4d86-a6e2-9662d7448aa4",
            "first_name": "Test Contact Name",
            "last_name": "Test Contact Lastname",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "account_name": "Currency Cloud Dev Centre",
            "status": "not_enabled",
            "locale": "en",
            "timezone": null,
            "email_address": "[email protected]",
            "mobile_phone_number": "",
            "phone_number": " 44 222 333444",
            "your_reference": "",
            "date_of_birth": "",
            "created_at": "2018-06-19T16:20:43+00:00",
            "updated_at": "2018-06-19T16:20:43+00:00"
        }
    ],
    "pagination": {
        "total_entries": 114,
        "total_pages": 5,
        "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
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