{"_id":"59d80bba47ed910010adaa28","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"user":"5588b847f6c18d0d005bba01","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-06T23:03:22.458Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"account\": null,\n  \t\"opportunities\": [],\n    \"openTasks\": {\n        \"tasks\": [],\n        \"hasMore\": false,\n        \"listLink\": \"https://na73.salesforce.com/007?id=00Q1I000001zqZ1UAI&rlid=RelatedActivityList&closed=0\"\n    },\n    \"closedTasks\": {\n        \"tasks\": [],\n        \"hasMore\": false,\n        \"listLink\": \"https://na73.salesforce.com/007?id=00Q1I000001zqZ1UAI&rlid=RelatedHistoryList&closed=1\"\n    },\n  \t\"contact\": null,\n    \"lead\": {\n        \"_id\": \"59d2ac7c0893c8e40cd46171\",\n        \"Id\": \"00Q1I000001zqZ1UAI\",\n        \"organizationId\": \"00D1I000000444EUAQ\",\n        \"type\": \"Lead\",\n        \"lastSyncedAt\": \"2017-10-06T01:00:00.817Z\",\n        \"IsDeleted\": false,\n        \"MasterRecordId\": null,\n        \"LastName\": \"Hello\",\n        \"FirstName\": \"Mixmax\",\n        \"Salutation\": null,\n        \"Name\": \"Mixmax Hello\",\n        \"Title\": null,\n        \"Company\": \"Mixmax\",\n        \"Street\": null,\n        \"City\": null,\n        \"State\": null,\n        \"PostalCode\": null,\n        \"Country\": null,\n        \"Latitude\": null,\n        \"Longitude\": null,\n        \"GeocodeAccuracy\": null,\n        \"Address\": null,\n        \"Phone\": null,\n        \"MobilePhone\": null,\n        \"Fax\": null,\n        \"Email\": \"hello:::at:::mixmax.com\",\n        \"Website\": null,\n        \"salesforceURL\": \"https://na73.salesforce.com/00Q1I000001zqZ1UAI\"\n    }\n}","name":""}]},"examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/salesforce/contactOrLead?email=hello@mixmax.com","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"59d7ce6f2b792f0010dc3a23","ref":"","in":"query","required":true,"desc":"The Email of the Contact or Lead to retrieve.","default":"","type":"string","name":"email"}],"url":"/v1/salesforce/contactOrLead"},"isReference":true,"order":85,"body":"This endpoint can be used to find a Contact or Lead knowing only its email.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"account\",\n    \"0-1\": \"Object\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"If there is a Salesforce Account associated with this Contact, then this property will contain that account with all its fields. *This is never set when the response contains a Lead.*\",\n    \"1-0\": \"closedTasks\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"Information about this Contact or Leads activity history.\",\n    \"2-0\": \"closedTasks.tasks\",\n    \"2-1\": \"Object[]\",\n    \"2-2\": \"An array of the 11 most recently closed tasks associated with this Contact or Lead.\",\n    \"3-0\": \"closedTasks.hasMore\",\n    \"3-1\": \"Boolean\",\n    \"3-2\": \"True if there are more closed Tasks associated with this Contact or Lead.\",\n    \"4-0\": \"closedTasks.listLink\",\n    \"4-1\": \"String\",\n    \"4-2\": \"A link to this Contact or Lead's activity history in salesforce.\",\n    \"5-0\": \"openTasks.tasks\",\n    \"5-1\": \"Object[]\",\n    \"5-2\": \"An array of the 11 most recently created open Tasks associated with this Contact or Lead.\",\n    \"6-0\": \"openTasks.hasMore\",\n    \"6-1\": \"Boolean\",\n    \"6-2\": \"True if there are more open Tasks associated with this Contact or Lead.\",\n    \"7-0\": \"openTasks.listLink\",\n    \"7-1\": \"String\",\n    \"7-2\": \"A link to this Contact or Lead's open task list.\",\n    \"8-0\": \"contact\",\n    \"8-1\": \"Object\",\n    \"8-2\": \"If the provided email is associated with an existing Contact, this object contains all of that Contact's fields.\",\n    \"9-0\": \"lead\",\n    \"9-1\": \"Object\",\n    \"9-2\": \"If the provided email is associated with an existing Lead, this object contains all of that Lead's fields.\",\n    \"10-0\": \"opportunities\",\n    \"10-1\": \"Object[]\",\n    \"10-2\": \"A list of opportunities associated with this Contact. *This is never set when returning a Lead.*\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","excerpt":"Get all information related to a Contact or Lead from an email address.","slug":"salesforcecontactorlead","type":"endpoint","title":"/salesforce/contactOrLead"}

get/salesforce/contactOrLead

Get all information related to a Contact or Lead from an email address.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

email:
required
string
The Email of the Contact or Lead to retrieve.

Examples


Result Format


Documentation

This endpoint can be used to find a Contact or Lead knowing only its email. [block:parameters] { "data": { "0-0": "account", "0-1": "Object", "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-2": "If there is a Salesforce Account associated with this Contact, then this property will contain that account with all its fields. *This is never set when the response contains a Lead.*", "1-0": "closedTasks", "1-1": "Object", "1-2": "Information about this Contact or Leads activity history.", "2-0": "closedTasks.tasks", "2-1": "Object[]", "2-2": "An array of the 11 most recently closed tasks associated with this Contact or Lead.", "3-0": "closedTasks.hasMore", "3-1": "Boolean", "3-2": "True if there are more closed Tasks associated with this Contact or Lead.", "4-0": "closedTasks.listLink", "4-1": "String", "4-2": "A link to this Contact or Lead's activity history in salesforce.", "5-0": "openTasks.tasks", "5-1": "Object[]", "5-2": "An array of the 11 most recently created open Tasks associated with this Contact or Lead.", "6-0": "openTasks.hasMore", "6-1": "Boolean", "6-2": "True if there are more open Tasks associated with this Contact or Lead.", "7-0": "openTasks.listLink", "7-1": "String", "7-2": "A link to this Contact or Lead's open task list.", "8-0": "contact", "8-1": "Object", "8-2": "If the provided email is associated with an existing Contact, this object contains all of that Contact's fields.", "9-0": "lead", "9-1": "Object", "9-2": "If the provided email is associated with an existing Lead, this object contains all of that Lead's fields.", "10-0": "opportunities", "10-1": "Object[]", "10-2": "A list of opportunities associated with this Contact. *This is never set when returning a Lead.*" }, "cols": 3, "rows": 11 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}