The single endpoint for retrieving the outcome of any asynchronous request, whichever endpoint created it.
A valid API key is required in the request header.
{
"message": "success",
"id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
"name": "weekly-batch",
"status": "pending",
"custom": { "batch": 42 },
"profile": { "total": 3, "valid": 3, "invalid": 0 }
}
No data key is present. Branch on status, never on whether data exists.
{
"message": "success",
"id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
"name": "weekly-batch",
"status": "completed",
"custom": { "batch": 42 },
"data": [
{ "linkedinUrl": "linkedin.com/in/qwerty",
"status": "completed",
"email": [ { "type": "work", "value": "example@deepenrich.com" } ],
"mobile": [ { "type": "personal", "value": "+1..." } ] },
{ "linkedinUrl": "linkedin.com/in/someProfile",
"status": "completed",
"email": [ { "type": "work", "value": "johndoe@deepenrich.com" } ] },
{ "linkedinUrl": "linkedin.com/in/qwerty-jane-roe",
"status": "not_found" }
]
}
When a request was made by contactId, the row is keyed by contactId rather than linkedinUrl.
Supplying webhookUrl on any asynchronous request removes the need to poll.
curl --request GET \
--url 'https://app.deepenrich.com/api/v1/contact/enrich?id=4fb3e13e-13c6-4f03-86aa-9ed2c651876e' \
--header 'Authorization: Bearer YOUR_API_KEY'
import requests
url = "https://app.deepenrich.com/api/v1/contact/enrich?id=4fb3e13e-13c6-4f03-86aa-9ed2c651876e"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.request("GET", url, headers=headers)
print(response.text)
const options = {
method: 'GET',
headers: {Authorization: 'Bearer YOUR_API_KEY'}
};
fetch('https://app.deepenrich.com/api/v1/contact/enrich?id=4fb3e13e-13c6-4f03-86aa-9ed2c651876e', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.deepenrich.com/api/v1/contact/enrich?id=4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer YOUR_API_KEY"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main
import (
"fmt"
"io/ioutil"
"net/http"
)
func main() {
url := "https://app.deepenrich.com/api/v1/contact/enrich?id=4fb3e13e-13c6-4f03-86aa-9ed2c651876e"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
HttpResponse<String> response = Unirest.get("https://app.deepenrich.com/api/v1/contact/enrich?id=4fb3e13e-13c6-4f03-86aa-9ed2c651876e")
.header("Authorization", "Bearer YOUR_API_KEY")
.asString();
{
"message": "success",
"id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
"name": "weekly-batch",
"status": "pending",
"custom": { "batch": 42 },
"profile": { "total": 3, "valid": 3, "invalid": 0 }
}
{
"message": "success",
"id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
"name": "weekly-batch",
"status": "completed",
"custom": { "batch": 42 },
"data": [
{
"linkedinUrl": "linkedin.com/in/qwerty",
"status": "completed",
"email": [ { "type": "work", "value": "example@deepenrich.com" } ],
"mobile": [ { "type": "personal", "value": "+1..." } ]
},
{
"linkedinUrl": "linkedin.com/in/someProfile",
"status": "completed",
"email": [ { "type": "work", "value": "johndoe@deepenrich.com" } ]
},
{
"linkedinUrl": "linkedin.com/in/qwerty-jane-roe",
"status": "not_found"
}
]
}
{
"message": "success",
"id": "4fb3e13e-13c6-4f03-86aa-9ed2c651876e",
"name": "weekly-batch",
"status": "interrupted",
"reason": "no purchase permission"
}
{
"message": "'id' is required"
}
{
"message": "Enrich request not found"
}
{
"message": "User not found"
}
{
"message": "Please provide valid api key"
}