Enrich Contacts (get)

Quota limitation

Results received from this endpoint count towards the contact enrichment quota and will consume credits

Provide an enrichment ID and the endpoint will return the corresponding enrichment's progress. Once it is completed, the response will also include the enrichment results.
The enrichment might take a few seconds to complete, we recommend polling this endpoint around once every second until a status other than IN_PROGRESS is received.

Authorization

AuthorizationRequiredBearer <token>

In: header

Path Parameters

idRequiredstring

Enrichment ID from where to retrieve the results

curl -X GET "https://api.surfe.com/v1/people/enrichments/bulk/"enrichment-id"" \
  -H "Authorization: Bearer <token>"

List of enriched contacts

{
  "createdAt": "2025-01-01T12:00:00.000000Z",
  "id": "enrichment-id",
  "people": [
    {
      "clientID": "DEPRECATED",
      "companyID": "DEPRECATED",
      "companyName": "ACME corp",
      "companyWebsite": "www.acme.org",
      "country": "United States",
      "departments": [
        "Engineering",
        "R&D"
      ],
      "emails": [
        {
          "email": "janedoe@acme.org",
          "validationStatus": "VALID"
        }
      ],
      "errors": [
        {
          "error": "Not enough mobile phone enrichment credits",
          "type": "NOT_ENOUGH_MOBILE_PHONE_CREDITS"
        }
      ],
      "expiresAt": "2025-01-01T12:00:00.000000+00:00",
      "externalID": "external-id",
      "facebookUrl": "https://www.facebook.com/janedoe",
      "firstName": "Jane",
      "id": "unique-id",
      "jobTitle": "Software engineer",
      "landlines": [
        {
          "landline": "555-555-555"
        }
      ],
      "lastName": "Doe",
      "linkedinUrl": "https://www.linkedin.com/in/janedoe/",
      "location": "Arizona",
      "mobilePhones": [
        {
          "confidenceScore": 0.8,
          "mobilePhone": "+123 4567890"
        }
      ],
      "name": "Jane Doe",
      "seniorities": [
        "Manager",
        "Head"
      ],
      "status": "IN_PROGRESS",
      "subdepartments": [
        "Software Development",
        "Product Management"
      ],
      "twitterUrl": "https://www.twitter.com/janedoe"
    }
  ],
  "status": "IN_PROGRESS"
}

Enrich Contacts (get)

Authorization

Path Parameters

Response

TypeScript