View a Lead
Example ID Request
$ curl \\\nhttps://api.intercom.io/contacts/5811f6bbe6b4704ddfa84ac0 \\\n-H 'Authorization:Bearer <Your access token>' \\\n-H 'Accept:application/json'\n\nor \n\n$ curl \\\n-s https://api.intercom.io/contacts?user_id=77177570-cf5d-4f1a-bc75-75202af47d4f \\\n-H 'Authorization:Bearer <Your access token>' \\\n-H 'Accept:application/json'
HTTP/1.1 200 OK\n\n{\n \"type\": \"contact\",\n \"id\": \"5811f6bbe6b4704ddfa84ac0\",\n \"user_id\": \"77177570-cf5d-4f1a-bc75-75202af47d4f\",\n \"anonymous\": true,\n \"email\": \"obrien@truth.org\",\n \"phone\": \"00353875551234\",\n \"name\": \"O'Brien\",\n \"pseudonym\": \"Lime Camel from Dublin\",\n ...\n}\n# NB: Full Lead objects are returned
Leads can be looked up individually via their id
, with a user_id
parameter, or with a phone
parameter.
user_id for leads
Remember that for leads the user_id will be automatically generated so it will look something like '8a88a590-e1c3-41e2-a502-e0649dbf721c'. (Note that this user_id is not retained when converting a lead to a user) For users the user_id is manually set so it will generally appear more like a regular number series e.g. '234'.