FullContact.getPersonFromEmail()

Retrieves contact information by e-mail address.

Read the docs here: https://www.fullcontact.com/developer/docs/person/

Usage

Hover over inputs/exits for more info.

var FullContact = require('machinepack-fullcontact');


// Retrieves contact information by e-mail address.

FullContact.getPersonFromEmail({

apiKey: '00011122233344455',

email: 'jane@example.com',

queue: '1',

webhookUrl: 'https://mydomain.com/callback/listener',

webhookId: 'myId',

webhookBody: 'json',

}).exec({

// An unexpected error occurred.

error: function (err) {

 

},

// FullContact says your API request was malformed

malformedRequest: function () {

 

},

// FulLContact says your API key is invalid or your rate limit has been reached.

apiKeyProblem: function () {

 

},

// FullContact says you have an invalid or missing query parameter.

queryParamProblem: function () {

 

},

// FullContact has queued the search and will have an answer shortly. If you don't want to wait, use the webhook input

queued: function () {

 

},

// FullContact says you have to wait 24 hours to try this query again.

wait24Hours: function () {

 

},

// OK.

success: function () {

 

},

});

Inputs

apiKey required

Your FullContact API key

'00011122233344455'
email required

The email address of the person you are looking up

'jane@example.com'
queue

Using this parameter notifies FullContact that the email address in question will be called later. It allows the API to make sure it has indexed the email address prior to the application needing it. When using this parameter, it will always return a response code of 202.

'1'
webhookUrl

The callback url you'd like the data to be posted back to.

'https://mydomain.com/callback/listener'
webhookId

You can enter anything you want here, we will just pass it back in the response. This allows you to track the webhook if you wish.

'myId'
webhookBody

You can specify that the payload of the webhook response be retuned as a JSON document instead of a URL-encoded form using the webhookBody=json query parameter. A JSON document will be the format regardless of whether the initial request to v2/Person was to the .json, .xml or .html version of the person endpoint.

'json'

Exits

error

An unexpected error occurred.

malformedRequest

FullContact says your API request was malformed

apiKeyProblem

FulLContact says your API key is invalid or your rate limit has been reached.

queryParamProblem

FullContact says you have an invalid or missing query parameter.

queued

FullContact has queued the search and will have an answer shortly. If you don't want to wait, use the webhook input

wait24Hours

FullContact says you have to wait 24 hours to try this query again.

success

OK.