• Quick Start
  • Send Survey
  • Get Contact
  • Remove Contact
  • Delete Contact (GDPR)
  • Get Unsubscribed
  • Get Responses
  • Get NPS
  • Sent Statistics
  • Historical Stats
  • Deactivate All
  • Bulk Add with CSV
  • Inapp Surveys
  • Bulk Add/Send

Change Log

  • Changes

Get a Contact

Get the details of a particular contact

API Endpoint

Make a GET request to https://DEMO.asknice.ly/api/v1/contact/get/search/key

Arguments

Argument Example Required Description
search schrodinger%40example.com Required URL-encoded value to search, eg email address of a contact
key email Required By default this is email, but you could search by any value eg a customer property set via the API

Example GET request

Search by email
curl --header "X-apikey: " \
https://DEMO.asknice.ly/api/v1/contact/get/schrodinger%40example.com/email
Search by id
curl --header "X-apikey: " \
https://DEMO.asknice.ly/api/v1/contact/get/your_id/id

Response

{
   "success":true,
   "data":{
      "id":"15816",
      "lastemailed":"1452219376",
      "active":"1",
      "created":"1418350105",
      "scheduled":"0",
      "name":"John Ballinger",
      "email":"john@asknice.ly",
      "segment":"VIP Customer",
      "importedattime":"1450653162",
      "source":"intercom",
      "intercomid":"548a4e19bcdac3592e0019b7",
      "unsubscribetime":null

   }
}