Surfe API
Get API KeySupportGive feedback

(Deprecated) Search People

Deprecated endpoint

This endpoint is deprecated. Please use the latest version here for improved functionality and support.

Quota limitation

Results received from this endpoint count towards the people search quota

Search for contacts based on the provided filters.
Additionally, this endpoint will automatically start the bulk enrichment of the search results. The enrichment will run asynchronously, in order to check the enrichment's progress and results, send a request to GET /v1/people/enrichments/bulk/{id}.
Note that some filters only accept pre-defined values, as provided by the filters endpoint.

POST
/v1/people/search

Authorization

AuthorizationRequiredBearer <token>

In: header

Request Body

application/jsonRequired

List of filters to use as search criteria

enrichmentTypeRequiredstring

Type of enrichment to execute

Value in: "email" | "mobile" | "emailAndMobile"
organizationFiltersobject

Filters that describe the organization where the person to look for works

organizationIDMappingsobject

Mapping of an organization domain to its corresponding ID. Search results associated with the same organization will return this ID in the externalID field

pageTokenstring
peopleFiltersobject
peoplePerOrganizationinteger

PeoplePerCompany - Limits the number of people returned per company when searching by domain or name only. Valid values are between 1 and 5. For more in-depth results, search using a single domain and omit this parameter. This field is ignored if the search includes criteria beyond domain or name.

requestedRequiredinteger

The maximum amount of results

Minimum: 1Maximum: 10000
searchNameRequiredstring

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

curl -X POST "https://api.surfe.com/v1/people/search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enrichmentType": "email",
    "organizationFilters": {
      "departmentSizes": [
        {
          "department": "Engineering",
          "from": 10,
          "to": 100
        }
      ],
      "employeeCounts": [
        "51-200",
        "201-500"
      ],
      "excludeDomains": [
        "surfe.com",
        "apple.com",
        "microsoft.com"
      ],
      "includeDomains": [
        "surfe.com",
        "apple.com",
        "microsoft.com"
      ],
      "includeNames": [
        "Surfe",
        "Apple",
        "Microsoft"
      ],
      "industries": [
        "Aerospace",
        "Software"
      ],
      "keywords": [
        "Recruitment",
        "Education"
      ],
      "locations": [
        "fr",
        "es"
      ],
      "primaryLocations": [
        "fr",
        "es"
      ],
      "revenues": [
        "0-1M",
        "1-10M"
      ],
      "states": [
        {
          "abbreviation": "IDF",
          "countryAlpha2": "fr"
        }
      ],
      "technologies": [
        "Mixpanel",
        "Salesforce"
      ]
    },
    "organizationIDMappings": {
      "apple.com": "external-id-2",
      "surfe.com": "external-id-1"
    },
    "pageToken": "string",
    "peopleFilters": {
      "countries": [
        "fr"
      ],
      "departments": [
        "Management"
      ],
      "jobTitles": [
        "CEO",
        "CTO"
      ],
      "seniorities": [
        "Founder",
        "C-Level"
      ]
    },
    "peoplePerOrganization": 5,
    "requested": 10,
    "searchName": "My list name"
  }'

List of people found, along with an enrichment ID

{
  "id": "enrichment-id",
  "people": [
    {
      "clientID": "DEPRECATED",
      "companyID": "DEPRECATED",
      "companyName": "ACME corp",
      "companyWebsite": "www.acme.org",
      "country": "United States",
      "departments": [
        "Engineering",
        "R&D"
      ],
      "externalID": "external-id",
      "facebookUrl": "https://www.facebook.com/janedoe",
      "firstName": "Jane",
      "id": "unique-id",
      "jobTitle": "Software engineer",
      "lastName": "Doe",
      "linkedinUrl": "https://www.linkedin.com/in/janedoe/",
      "location": "Arizona",
      "name": "Jane Doe",
      "seniorities": [
        "Manager",
        "Head"
      ],
      "subdepartments": [
        "Software Development",
        "Product Management"
      ],
      "twitterUrl": "https://www.twitter.com/janedoe"
    }
  ]
}