Surfe API
Get API KeySupportGive feedback

(Deprecated) Enrich People (bulk) (start)

Quota limitation

This endpoint will not succeed if there is not enough people enrichment quota or credits available

Starts bulk enriching the provided list of people and returns an enrichment ID.

Enrichment runs asynchronously. To be notified when the enrichments are complete, we highly recommend using the notificationOptions.webhookUrl field. This enables webhook notifications that automatically send the result to your server when ready. For more details, see the webhook documentation here.

Alternatively, you can manually check the enrichment's progress and results by sending a request to GET /v2/people/enrich/:id. However, polling is less efficient and may introduce delays or unnecessary load.

Looking for V1? It’s deprecated, but still available here.
Single person enrichment is deprecated too. You can learn more here.

POST
/v1/people/enrichments/bulk

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

People to enrich

enrichmentTypeRequiredstring
Value in: "email" | "mobile" | "emailAndMobile"
listNameRequiredstring

Name for the new list that will created to store the results

peopleRequiredarray<object>

List of people to enrich (maximum 10000)

Provide either a linkedinUrl or a combination of "firstName lastName companyName" or combination of "firstName lastName companyWebsite"

curl -X POST "https://api.surfe.com/v1/people/enrichments/bulk" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enrichmentType": "email",
    "listName": "My list name",
    "people": [
      {
        "clientID": "DEPRECATED",
        "companyName": "ACME corp",
        "companyWebsite": "acme.org",
        "externalID": "external-id",
        "firstName": "Jane",
        "lastName": "Doe",
        "linkedinUrl": "https://www.linkedin.com/in/janedoe/"
      }
    ]
  }'

Enrichment ID

{
  "id": "enrichment-id",
  "listName": "My list name"
}