People / Search

Scroll

Cost: 2 credits per person returned. 2 credits minimum if no results are found.

Searches people based on given criteria using cursor-based pagination.

You can request the next page of results by using the cursor parameter. The cursor is a string that encodes the current position in the result set. In case no cursor is provided, the first page of results is returned. You can then use the next_cursor parameter to get the next page of results.

This will allow you to scroll over the results without having to keep track of the current page number and also allow paginating into more than 10.000 results.

post/people/search/scroll

Request

  • Base URL: https://api.companyenrich.com
  • URL: https://api.companyenrich.com/people/search/scroll
  • Auth: API key in header Authorization

Query parameters

expandstring[]

Expandable response fields. Repeat the parameter to request multiple expansions.

Supported values:

  • education: costs 1 credit per person and adds the education field to PersonInfo.

Request body

pageSizeinteger

The number of results to return in each page. Must be between 1 and 100

cursorstring nullable

The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.

querystring nullable

The search query to apply on the company name and domain

positionQuerystring[] nullable

The list of search queries to apply on the person's current job position/title

atCurrentCompanyAfterstring date-time nullable

Filter by current company join date - only include people who joined after this UTC date

atCurrentCompanyBeforestring date-time nullable

Filter by current company join date - only include people who joined before this UTC date

atCurrentPositionAfterstring date-time nullable

Filter by current position start date - only include people who started after this UTC date

atCurrentPositionBeforestring date-time nullable

Filter by current position start date - only include people who started before this UTC date

countriesstring[] nullable

The 2 letter country codes to filter by

domainsstring[] nullable

The domains to find people for. Up to 2,500 domains are allowed.

seniorityPersonSeniority[] nullable

The seniorities to filter by

departmentPersonDepartment[] nullable

The departments to filter by

Response

OK

nextCursorstring nullable

The cursor for the next page

previousCursorstring nullable

The cursor for the previous page

totalItemsinteger

The total number of items in the list

startIndexinteger nullable

The index of the first item in the entire result set

Changes

No recorded changes to this operation across all 1 revision of this API.