Find People

caution

Rate limits always apply on all routes. Check the dedicated page for more information.

Available filters

Below is the list of available filters that can be used to search the people dataset:

Filter name	Description	Type	Examples	Constraints
firstname	The first name of a person	Include/Exclude	"firstname": { "include": ["John", "Jane"], "exclude": ["Alice"] }	This is a open text field. You can put whatever you want.
lastname	The last name of a person	Include/Exclude	"lastname": { "include": ["Doe", "Smith"], "exclude": ["Brown"] }	This is a open text field. You can put whatever you want.
currentJobTitle	The current job title of a person	Include/Exclude	"currentJobTitle": { "include": ["Software Engineer", "Manager"], "exclude": ["Intern"] }	This is a open text field. You can put whatever you want.
pastJobTitle	The past job title of a person	Include/Exclude	"pastJobTitle": { "include": ["Developer", "Analyst"], "exclude": ["Consultant"] }	This is a open text field. You can put whatever you want.
currentCompanyName	The name of the company where the person currently works	Include/Exclude	"currentCompanyName": { "include": ["Google", "Microsoft"], "exclude": ["Facebook"] }	This is a open text field. You can put whatever you want.
pastCompanyName	The name of the previous company	Include/Exclude	"pastCompanyName": { "include": ["Amazon", "IBM"], "exclude": ["Oracle"] }	This is a open text field. You can put whatever you want.
currentCompanyUrn	The URN of the company where the person currently works	Include/Exclude	"currentCompanyUrn": { "include": ["1234", "5678"] }	This is a numeric field. It should contain valid company URNs.
pastCompanyUrn	The URN of the previous company	Include/Exclude	"pastCompanyUrn": { "include": ["3456", "7890"] }	This is a numeric field. It should contain valid company URNs.
school	The name of the school attended by the person	Include/Exclude	"school": { "include": ["Stanford", "Harvard"], "exclude": ["MIT"] }	This is an open text field. You can put whatever you want.
languages	The languages spoken by the person	Include/Exclude	"languages": { "include": ["English", "Spanish"], "exclude": ["French"] }	This is a text field. It should contain valid language names or alpha-2 language codes.
skills	The skills possessed by the person	Include/Exclude	"skills": { "include": ["JavaScript", "Python"], "exclude": ["Java"] }	This is a text field. It should contain valid skill names.
location	The location of the person	Include/Exclude	"location": { "include": ["New York", "San Francisco"], "exclude": ["Los Angeles"] }	You can put the name of a city, a country, a state, but for best results we strongly advised to use alpha-2 country code (IN, FR, US, ...)
keyword	A special filter that search across the entire profile (past & current job titles, job descriptions, skills, profile headline & descriptions, educations, ...)	Include/Exclude	"keyword": { "include": ["CEO", "Co-Founder"] }	This is an open text field, you can put whatever you want.

Query examples

Search for all people currently empolyed as CTO in the US

{
    "query": {
        "currentJobTitle": { "include": ["CTO", "Chief Technical Officer"] },
        "location": { "include": ["US"] }
    }
}

Search for all people speaking English in France

{
    "query": {
        "languages": { "include": ["EN"] },
        "location": { "include": ["FR"] }
    }
}

Search for all engineers working at Apple

{
    "query": {
        "currentJobTitle": { "include": ["engineer"] },
        "currentCompanyName": { "include": ["apple"] }
    }
}

Count the number of people matching your query

When you need to assess the number of people returned by a specific query, you should use this route. We do not charge anything when using this route.

POSThttps://app.icypeas.com/api/find-people/count

BODY PARAMS

query*object(should be a valid query (see available fields above))

The query

RESPONSES

Find people

When you want to retrieve the results for your query, you should use this route. The route is paginated, please see below on how to handle pagination.

POSThttps://app.icypeas.com/api/find-people

BODY PARAMS

query*object(should be a valid query (see available fields above))

The query

paginationobject(should be a valid pagination object)

This is optional and used only if you want to retrieve more people than the first page.

token*string(should be a valid pagination token)

The pagination token

sizenumber(should be a valid integer between 1 and 200)

The number of people returned per page

Default Value :100

RESPONSES

Pagination

The results of a query are paginated depending of the size parameter you have given inside the pagination object (default value is 100). If you need to fetch more than the first 100 results, you need to use the pagination mecanism. To do so, it's easy, when the number of results is greater than the size, we will return a pagination object that looks like:

{
    "pagination": {
        "size": 100,
        "token": "eyJzYSI6W1syXSxbMTI4ODQ5MDE5MDJdXSwiaWQiOiIwOGZzQXc4eGFXTjVjR1ZoY3kxemJuTXRaR1YyWld4dmNHMWxiblF0YkdsdWEyVmthVzR0WTI5dGNHRnVlUzB5TURJME1URXhOUlpVUjI5MlYyNVJNMUkyTm1adlRUTnRVR0Y0TmpObkJoWmlMVGwwUm1wYVRsSjBUMU5XYlVKYWJHOUNSa1pCQUFBQUFBQUFQRFpJRmpsU2JqSlRUMEZYVWxWSE0zRk1WRTh5YTFoUGJsRUFNV2xqZVhCbFlYTXRjMjV6TFdSbGRtVnNiM0J0Wlc1MExXeHBibXRsWkdsdUxXTnZiWEJoYm5rdE1qQXlOREV4TVRVV1ZFZHZkbGR1VVROU05qWm1iMDB6YlZCaGVEWXpad1VXWWkwNWRFWnFXazVTZEU5VFZtMUNXbXh2UWtaR1FRQUFBQUFBQUR3MlJ4WTVVbTR5VTA5QlYxSlZSek54VEZSUE1tdFlUMjVSQURGcFkzbHdaV0Z6TFhOdWN5MWtaWFpsYkc5d2JXVnVkQzFzYVc1clpXUnBiaTFqYjIxd1lXNTVMVEl3TWpReE1URTFGbFJIYjNaWGJsRXpValkyWm05Tk0yMVFZWGcyTTJjSUZtSXRPWFJHYWxwT1VuUlBVMVp0UWxwc2IwSkdSa0VBQUFBQUFBQThOa29XT1ZKdU1sTlBRVmRTVlVjemNVeFVUekpyV0U5dVVRQXhhV041Y0dWaGN5MXpibk10WkdWMlpXeHZjRzFsYm5RdGJHbHVhMlZrYVc0dFkyOXRjR0Z1ZVMweU1ESTBNVEV4TlJaVVIyOTJWMjVSTTFJMk5tWnZUVE50VUdGNE5qTm5CeFppTFRsMFJtcGFUbEowVDFOV2JVSmFiRzlDUmtaQkFBQUFBQUFBUERaSkZqbFNiakpUVDBGWFVsVkhNM0ZNVkU4eWExaFBibEVBTVdsamVYQmxZWE10YzI1ekxXUmxkbVZzYjNCdFpXNTBMV3hwYm10bFpHbHVMV052YlhCaGJua3RNakF5TkRFeE1UVVdWRWR2ZGxkdVVUTlNOalptYjAwemJWQmhlRFl6WndvV1lpMDVkRVpxV2s1U2RFOVRWbTFDV214dlFrWkdRUUFBQUFBQUFEdzJUQlk1VW00eVUwOUJWMUpWUnpOeFRGUlBNbXRZVDI1UkFERnBZM2x3WldGekxYTnVjeTFrWlhabGJHOXdiV1Z1ZEMxc2FXNXJaV1JwYmkxamIyMXdZVzU1TFRJd01qUXhNVEUxRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY0pGbUl0T1hSR2FscE9VblJQVTFadFFscHNiMEpHUmtFQUFBQUFBQUE4TmtzV09WSnVNbE5QUVZkU1ZVY3pjVXhVVHpKcldFOXVVUUF4YVdONWNHVmhjeTF6Ym5NdFpHVjJaV3h2Y0cxbGJuUXRiR2x1YTJWa2FXNHRZMjl0Y0dGdWVTMHlNREkwTVRFeE5SWlVSMjkyVjI1Uk0xSTJObVp2VFROdFVHRjROak5uREJaaUxUbDBSbXBhVGxKMFQxTldiVUphYkc5Q1JrWkJBQUFBQUFBQVBEWk9GamxTYmpKVFQwRlhVbFZITTNGTVZFOHlhMWhQYmxFQU1XbGplWEJsWVhNdGMyNXpMV1JsZG1Wc2IzQnRaVzUwTFd4cGJtdGxaR2x1TFdOdmJYQmhibmt0TWpBeU5ERXhNVFVXVkVkdmRsZHVVVE5TTmpabWIwMHpiVkJoZURZelp3c1dZaTA1ZEVacVdrNVNkRTlUVm0xQ1dteHZRa1pHUVFBQUFBQUFBRHcyVFJZNVVtNHlVMDlCVjFKVlJ6TnhURlJQTW10WVQyNVJBREZwWTNsd1pXRnpMWE51Y3kxa1pYWmxiRzl3YldWdWRDMXNhVzVyWldScGJpMWpiMjF3WVc1NUxUSXdNalF4TVRFMUZsUkhiM1pYYmxFelVqWTJabTlOTTIxUVlYZzJNMmNBRm1JdE9YUkdhbHBPVW5SUFUxWnRRbHBzYjBKR1JrRUFBQUFBQUFBOE5rSVdPVkp1TWxOUFFWZFNWVWN6Y1V4VVR6SnJXRTl1VVFBeGFXTjVjR1ZoY3kxemJuTXRaR1YyWld4dmNHMWxiblF0YkdsdWEyVmthVzR0WTI5dGNHRnVlUzB5TURJME1URXhOUlpVUjI5MlYyNVJNMUkyTm1adlRUTnRVR0Y0TmpObkFoWmlMVGwwUm1wYVRsSjBUMU5XYlVKYWJHOUNSa1pCQUFBQUFBQUFQRFpFRmpsU2JqSlRUMEZYVWxWSE0zRk1WRTh5YTFoUGJsRUFNV2xqZVhCbFlYTXRjMjV6TFdSbGRtVnNiM0J0Wlc1MExXeHBibXRsWkdsdUxXTnZiWEJoYm5rdE1qQXlOREV4TVRVV1ZFZHZkbGR1VVROU05qWm1iMDB6YlZCaGVEWXpad0VXWWkwNWRFWnFXazVTZEU5VFZtMUNXbXh2UWtaR1FRQUFBQUFBQUR3MlF4WTVVbTR5VTA5QlYxSlZSek54VEZSUE1tdFlUMjVSQURGcFkzbHdaV0Z6TFhOdWN5MWtaWFpsYkc5d2JXVnVkQzFzYVc1clpXUnBiaTFqYjIxd1lXNTVMVEl3TWpReE1URTFGbFJIYjNaWGJsRXpValkyWm05Tk0yMVFZWGcyTTJjRUZtSXRPWFJHYWxwT1VuUlBVMVp0UWxwc2IwSkdSa0VBQUFBQUFBQThOa1lXT1ZKdU1sTlBRVmRTVlVjemNVeFVUekpyV0U5dVVRQXhhV041Y0dWaGN5MXpibk10WkdWMlpXeHZjRzFsYm5RdGJHbHVhMlZrYVc0dFkyOXRjR0Z1ZVMweU1ESTBNVEV4TlJaVVIyOTJWMjVSTTFJMk5tWnZUVE50VUdGNE5qTm5BeFppTFRsMFJtcGFUbEowVDFOV2JVSmFiRzlDUmtaQkFBQUFBQUFBUERaRkZqbFNiakpUVDBGWFVsVkhNM0ZNVkU4eWExaFBibEVBTVdsamVYQmxZWE10YzI1ekxXUmxkbVZzYjNCdFpXNTBMV3hwYm10bFpHbHVMV052YlhCaGJua3RNakF5TkRFeE1UVVdWRWR2ZGxkdVVUTlNOalptYjAwemJWQmhlRFl6Wnc0V1lpMDVkRVpxV2s1U2RFOVRWbTFDV214dlFrWkdRUUFBQUFBQUFEdzJVQlk1VW00eVUwOUJWMUpWUnpOeFRGUlBNbXRZVDI1UkFERnBZM2x3WldGekxYTnVjeTFrWlhabGJHOXdiV1Z1ZEMxc2FXNXJaV1JwYmkxamIyMXdZVzU1TFRJd01qUXhNVEUxRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY05GbUl0T1hSR2FscE9VblJQVTFadFFscHNiMEpHUmtFQUFBQUFBQUE4Tms4V09WSnVNbE5QUVZkU1ZVY3pjVXhVVHpKcldFOXVVUUFCRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY0FBQT09IiwiZklkIjoieFgwVzBKY0JDZGpFUUxvRlpZcjIifx=="
    }
}

You just have to pass this pagination object to your request each time you want to fetch more results.

Let's take an example here:

Imagine you want all companies with more than 10 employees and only return 2 companies per page. Your initial query will look like this:

Example of first request

{
    "query": {
        "headcount": { ">": 10 }
    },
    "pagination": { "size": 2 }
}

The system will return something like:

First response from Icypeas

    "success": true,
    "total": 845,
    "leads": [
{
    "name": "Harvard Graduate School of Education",
    "lid": "hgse",
    "urn": "urn:li:fs_salesCompany:1653",
    "url": "https://www.linkedin.com/company/hgse/",
    "description": "Education touches every aspect of human activity. At the Harvard Graduate School of Education (HGSE), we believe studying and improving the enterprise of education are central to the health and future of society.",
    "address": "Cambridge, Massachusetts, United States",
    "numberOfEmployees": 1134,
    "industry": "Higher Education",
    "website": "http://www.gse.harvard.edu",
    "specialties": [],
    "employeeGrowth": [],
    "_id": "sMMXT5MBIateb5xQKCCK"
},
{
    "name": "Trammell Crow Company",
    "lid": "trammell-crow-company",
    "urn": "urn:li:fs_salesCompany:2320",
    "url": "https://www.linkedin.com/company/trammell-crow-company/",
    "description": "Trammell Crow Company (TCC) is a global commercial real estate developer and wholly-owned subsidiary of CBRE Group, Inc. (NYSE:CBRE), a Fortune 500 and S&P 500 company headquartered in Dallas. Founded in 1948, TCC has developed or acquired nearly 2,900 buildings valued at $75 billion and over 655 million square feet. As of September 30, 2024, TCC had $19 billion of projects in process and $13.4 billion in its pipeline. With 575 employees throughout the United States and Europe in 27 offices, the company serves users of and investors in office, industrial/logistics, healthcare, life science, data center and mixed-use projects, as well as multi-family residential through its operating subsidiary High Street Residential. For more information visit www.TrammellCrow.com.",
    "address": "Dallas, Texas, United States",
    "numberOfEmployees": 989,
    "industry": "Real Estate",
    "website": "http://www.trammellcrow.com",
    "specialties": [],
    "employeeGrowth": [],
    "_id": "-sMXT5MBIateb5xQeCIO"
},
    ],
    "pagination": {
      "size": 2,
      "token": "eyJzYSI6W1syXSxbMTI4ODQ5MDE5MDJdXSwiaWQiOiIwOGZzQXc4eGFXTjVjR1ZoY3kxemJuTXRaR1YyWld4dmNHMWxiblF0YkdsdWEyVmthVzR0WTI5dGNHRnVlUzB5TURJME1URXhOUlpVUjI5MlYyNVJNMUkyTm1adlRUTnRVR0Y0TmpObkJoWmlMVGwwUm1wYVRsSjBUMU5XYlVKYWJHOUNSa1pCQUFBQUFBQUFQRFpJRmpsU2JqSlRUMEZYVWxWSE0zRk1WRTh5YTFoUGJsRUFNV2xqZVhCbFlYTXRjMjV6TFdSbGRtVnNiM0J0Wlc1MExXeHBibXRsWkdsdUxXTnZiWEJoYm5rdE1qQXlOREV4TVRVV1ZFZHZkbGR1VVROU05qWm1iMDB6YlZCaGVEWXpad1VXWWkwNWRFWnFXazVTZEU5VFZtMUNXbXh2UWtaR1FRQUFBQUFBQUR3MlJ4WTVVbTR5VTA5QlYxSlZSek54VEZSUE1tdFlUMjVSQURGcFkzbHdaV0Z6TFhOdWN5MWtaWFpsYkc5d2JXVnVkQzFzYVc1clpXUnBiaTFqYjIxd1lXNTVMVEl3TWpReE1URTFGbFJIYjNaWGJsRXpValkyWm05Tk0yMVFZWGcyTTJjSUZtSXRPWFJHYWxwT1VuUlBVMVp0UWxwc2IwSkdSa0VBQUFBQUFBQThOa29XT1ZKdU1sTlBRVmRTVlVjemNVeFVUekpyV0U5dVVRQXhhV041Y0dWaGN5MXpibk10WkdWMlpXeHZjRzFsYm5RdGJHbHVhMlZrYVc0dFkyOXRjR0Z1ZVMweU1ESTBNVEV4TlJaVVIyOTJWMjVSTTFJMk5tWnZUVE50VUdGNE5qTm5CeFppTFRsMFJtcGFUbEowVDFOV2JVSmFiRzlDUmtaQkFBQUFBQUFBUERaSkZqbFNiakpUVDBGWFVsVkhNM0ZNVkU4eWExaFBibEVBTVdsamVYQmxZWE10YzI1ekxXUmxkbVZzYjNCdFpXNTBMV3hwYm10bFpHbHVMV052YlhCaGJua3RNakF5TkRFeE1UVVdWRWR2ZGxkdVVUTlNOalptYjAwemJWQmhlRFl6WndvV1lpMDVkRVpxV2s1U2RFOVRWbTFDV214dlFrWkdRUUFBQUFBQUFEdzJUQlk1VW00eVUwOUJWMUpWUnpOeFRGUlBNbXRZVDI1UkFERnBZM2x3WldGekxYTnVjeTFrWlhabGJHOXdiV1Z1ZEMxc2FXNXJaV1JwYmkxamIyMXdZVzU1TFRJd01qUXhNVEUxRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY0pGbUl0T1hSR2FscE9VblJQVTFadFFscHNiMEpHUmtFQUFBQUFBQUE4TmtzV09WSnVNbE5QUVZkU1ZVY3pjVXhVVHpKcldFOXVVUUF4YVdONWNHVmhjeTF6Ym5NdFpHVjJaV3h2Y0cxbGJuUXRiR2x1YTJWa2FXNHRZMjl0Y0dGdWVTMHlNREkwTVRFeE5SWlVSMjkyVjI1Uk0xSTJObVp2VFROdFVHRjROak5uREJaaUxUbDBSbXBhVGxKMFQxTldiVUphYkc5Q1JrWkJBQUFBQUFBQVBEWk9GamxTYmpKVFQwRlhVbFZITTNGTVZFOHlhMWhQYmxFQU1XbGplWEJsWVhNdGMyNXpMV1JsZG1Wc2IzQnRaVzUwTFd4cGJtdGxaR2x1TFdOdmJYQmhibmt0TWpBeU5ERXhNVFVXVkVkdmRsZHVVVE5TTmpabWIwMHpiVkJoZURZelp3c1dZaTA1ZEVacVdrNVNkRTlUVm0xQ1dteHZRa1pHUVFBQUFBQUFBRHcyVFJZNVVtNHlVMDlCVjFKVlJ6TnhURlJQTW10WVQyNVJBREZwWTNsd1pXRnpMWE51Y3kxa1pYWmxiRzl3YldWdWRDMXNhVzVyWldScGJpMWpiMjF3WVc1NUxUSXdNalF4TVRFMUZsUkhiM1pYYmxFelVqWTJabTlOTTIxUVlYZzJNMmNBRm1JdE9YUkdhbHBPVW5SUFUxWnRRbHBzYjBKR1JrRUFBQUFBQUFBOE5rSVdPVkp1TWxOUFFWZFNWVWN6Y1V4VVR6SnJXRTl1VVFBeGFXTjVjR1ZoY3kxemJuTXRaR1YyWld4dmNHMWxiblF0YkdsdWEyVmthVzR0WTI5dGNHRnVlUzB5TURJME1URXhOUlpVUjI5MlYyNVJNMUkyTm1adlRUTnRVR0Y0TmpObkFoWmlMVGwwUm1wYVRsSjBUMU5XYlVKYWJHOUNSa1pCQUFBQUFBQUFQRFpFRmpsU2JqSlRUMEZYVWxWSE0zRk1WRTh5YTFoUGJsRUFNV2xqZVhCbFlYTXRjMjV6TFdSbGRtVnNiM0J0Wlc1MExXeHBibXRsWkdsdUxXTnZiWEJoYm5rdE1qQXlOREV4TVRVV1ZFZHZkbGR1VVROU05qWm1iMDB6YlZCaGVEWXpad0VXWWkwNWRFWnFXazVTZEU5VFZtMUNXbXh2UWtaR1FRQUFBQUFBQUR3MlF4WTVVbTR5VTA5QlYxSlZSek54VEZSUE1tdFlUMjVSQURGcFkzbHdaV0Z6TFhOdWN5MWtaWFpsYkc5d2JXVnVkQzFzYVc1clpXUnBiaTFqYjIxd1lXNTVMVEl3TWpReE1URTFGbFJIYjNaWGJsRXpValkyWm05Tk0yMVFZWGcyTTJjRUZtSXRPWFJHYWxwT1VuUlBVMVp0UWxwc2IwSkdSa0VBQUFBQUFBQThOa1lXT1ZKdU1sTlBRVmRTVlVjemNVeFVUekpyV0U5dVVRQXhhV041Y0dWaGN5MXpibk10WkdWMlpXeHZjRzFsYm5RdGJHbHVhMlZrYVc0dFkyOXRjR0Z1ZVMweU1ESTBNVEV4TlJaVVIyOTJWMjVSTTFJMk5tWnZUVE50VUdGNE5qTm5BeFppTFRsMFJtcGFUbEowVDFOV2JVSmFiRzlDUmtaQkFBQUFBQUFBUERaRkZqbFNiakpUVDBGWFVsVkhNM0ZNVkU4eWExaFBibEVBTVdsamVYQmxZWE10YzI1ekxXUmxkbVZzYjNCdFpXNTBMV3hwYm10bFpHbHVMV052YlhCaGJua3RNakF5TkRFeE1UVVdWRWR2ZGxkdVVUTlNOalptYjAwemJWQmhlRFl6Wnc0V1lpMDVkRVpxV2s1U2RFOVRWbTFDV214dlFrWkdRUUFBQUFBQUFEdzJVQlk1VW00eVUwOUJWMUpWUnpOeFRGUlBNbXRZVDI1UkFERnBZM2x3WldGekxYTnVjeTFrWlhabGJHOXdiV1Z1ZEMxc2FXNXJaV1JwYmkxamIyMXdZVzU1TFRJd01qUXhNVEUxRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY05GbUl0T1hSR2FscE9VblJQVTFadFFscHNiMEpHUmtFQUFBQUFBQUE4Tms4V09WSnVNbE5QUVZkU1ZVY3pjVXhVVHpKcldFOXVVUUFCRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY0FBQT09IiwiZklkIjoieFgwVzBKY0JDZGpFUUxvRlpZcjIifx=="
    }

If you want to fetch the next page, just pass the returned pagination object along your next query:

Your second request to fetch more results

{
    "query": {
        "headcount": { ">": 10 }
    },
    "pagination": { 
      "size": 2,
      "token": "eyJzYSI6W1syXSxbMTI4ODQ5MDE5MDJdXSwiaWQiOiIwOGZzQXc4eGFXTjVjR1ZoY3kxemJuTXRaR1YyWld4dmNHMWxiblF0YkdsdWEyVmthVzR0WTI5dGNHRnVlUzB5TURJME1URXhOUlpVUjI5MlYyNVJNMUkyTm1adlRUTnRVR0Y0TmpObkJoWmlMVGwwUm1wYVRsSjBUMU5XYlVKYWJHOUNSa1pCQUFBQUFBQUFQRFpJRmpsU2JqSlRUMEZYVWxWSE0zRk1WRTh5YTFoUGJsRUFNV2xqZVhCbFlYTXRjMjV6TFdSbGRtVnNiM0J0Wlc1MExXeHBibXRsWkdsdUxXTnZiWEJoYm5rdE1qQXlOREV4TVRVV1ZFZHZkbGR1VVROU05qWm1iMDB6YlZCaGVEWXpad1VXWWkwNWRFWnFXazVTZEU5VFZtMUNXbXh2UWtaR1FRQUFBQUFBQUR3MlJ4WTVVbTR5VTA5QlYxSlZSek54VEZSUE1tdFlUMjVSQURGcFkzbHdaV0Z6TFhOdWN5MWtaWFpsYkc5d2JXVnVkQzFzYVc1clpXUnBiaTFqYjIxd1lXNTVMVEl3TWpReE1URTFGbFJIYjNaWGJsRXpValkyWm05Tk0yMVFZWGcyTTJjSUZtSXRPWFJHYWxwT1VuUlBVMVp0UWxwc2IwSkdSa0VBQUFBQUFBQThOa29XT1ZKdU1sTlBRVmRTVlVjemNVeFVUekpyV0U5dVVRQXhhV041Y0dWaGN5MXpibk10WkdWMlpXeHZjRzFsYm5RdGJHbHVhMlZrYVc0dFkyOXRjR0Z1ZVMweU1ESTBNVEV4TlJaVVIyOTJWMjVSTTFJMk5tWnZUVE50VUdGNE5qTm5CeFppTFRsMFJtcGFUbEowVDFOV2JVSmFiRzlDUmtaQkFBQUFBQUFBUERaSkZqbFNiakpUVDBGWFVsVkhNM0ZNVkU4eWExaFBibEVBTVdsamVYQmxZWE10YzI1ekxXUmxkbVZzYjNCdFpXNTBMV3hwYm10bFpHbHVMV052YlhCaGJua3RNakF5TkRFeE1UVVdWRWR2ZGxkdVVUTlNOalptYjAwemJWQmhlRFl6WndvV1lpMDVkRVpxV2s1U2RFOVRWbTFDV214dlFrWkdRUUFBQUFBQUFEdzJUQlk1VW00eVUwOUJWMUpWUnpOeFRGUlBNbXRZVDI1UkFERnBZM2x3WldGekxYTnVjeTFrWlhabGJHOXdiV1Z1ZEMxc2FXNXJaV1JwYmkxamIyMXdZVzU1TFRJd01qUXhNVEUxRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY0pGbUl0T1hSR2FscE9VblJQVTFadFFscHNiMEpHUmtFQUFBQUFBQUE4TmtzV09WSnVNbE5QUVZkU1ZVY3pjVXhVVHpKcldFOXVVUUF4YVdONWNHVmhjeTF6Ym5NdFpHVjJaV3h2Y0cxbGJuUXRiR2x1YTJWa2FXNHRZMjl0Y0dGdWVTMHlNREkwTVRFeE5SWlVSMjkyVjI1Uk0xSTJObVp2VFROdFVHRjROak5uREJaaUxUbDBSbXBhVGxKMFQxTldiVUphYkc5Q1JrWkJBQUFBQUFBQVBEWk9GamxTYmpKVFQwRlhVbFZITTNGTVZFOHlhMWhQYmxFQU1XbGplWEJsWVhNdGMyNXpMV1JsZG1Wc2IzQnRaVzUwTFd4cGJtdGxaR2x1TFdOdmJYQmhibmt0TWpBeU5ERXhNVFVXVkVkdmRsZHVVVE5TTmpabWIwMHpiVkJoZURZelp3c1dZaTA1ZEVacVdrNVNkRTlUVm0xQ1dteHZRa1pHUVFBQUFBQUFBRHcyVFJZNVVtNHlVMDlCVjFKVlJ6TnhURlJQTW10WVQyNVJBREZwWTNsd1pXRnpMWE51Y3kxa1pYWmxiRzl3YldWdWRDMXNhVzVyWldScGJpMWpiMjF3WVc1NUxUSXdNalF4TVRFMUZsUkhiM1pYYmxFelVqWTJabTlOTTIxUVlYZzJNMmNBRm1JdE9YUkdhbHBPVW5SUFUxWnRRbHBzYjBKR1JrRUFBQUFBQUFBOE5rSVdPVkp1TWxOUFFWZFNWVWN6Y1V4VVR6SnJXRTl1VVFBeGFXTjVjR1ZoY3kxemJuTXRaR1YyWld4dmNHMWxiblF0YkdsdWEyVmthVzR0WTI5dGNHRnVlUzB5TURJME1URXhOUlpVUjI5MlYyNVJNMUkyTm1adlRUTnRVR0Y0TmpObkFoWmlMVGwwUm1wYVRsSjBUMU5XYlVKYWJHOUNSa1pCQUFBQUFBQUFQRFpFRmpsU2JqSlRUMEZYVWxWSE0zRk1WRTh5YTFoUGJsRUFNV2xqZVhCbFlYTXRjMjV6TFdSbGRtVnNiM0J0Wlc1MExXeHBibXRsWkdsdUxXTnZiWEJoYm5rdE1qQXlOREV4TVRVV1ZFZHZkbGR1VVROU05qWm1iMDB6YlZCaGVEWXpad0VXWWkwNWRFWnFXazVTZEU5VFZtMUNXbXh2UWtaR1FRQUFBQUFBQUR3MlF4WTVVbTR5VTA5QlYxSlZSek54VEZSUE1tdFlUMjVSQURGcFkzbHdaV0Z6TFhOdWN5MWtaWFpsYkc5d2JXVnVkQzFzYVc1clpXUnBiaTFqYjIxd1lXNTVMVEl3TWpReE1URTFGbFJIYjNaWGJsRXpValkyWm05Tk0yMVFZWGcyTTJjRUZtSXRPWFJHYWxwT1VuUlBVMVp0UWxwc2IwSkdSa0VBQUFBQUFBQThOa1lXT1ZKdU1sTlBRVmRTVlVjemNVeFVUekpyV0U5dVVRQXhhV041Y0dWaGN5MXpibk10WkdWMlpXeHZjRzFsYm5RdGJHbHVhMlZrYVc0dFkyOXRjR0Z1ZVMweU1ESTBNVEV4TlJaVVIyOTJWMjVSTTFJMk5tWnZUVE50VUdGNE5qTm5BeFppTFRsMFJtcGFUbEowVDFOV2JVSmFiRzlDUmtaQkFBQUFBQUFBUERaRkZqbFNiakpUVDBGWFVsVkhNM0ZNVkU4eWExaFBibEVBTVdsamVYQmxZWE10YzI1ekxXUmxkbVZzYjNCdFpXNTBMV3hwYm10bFpHbHVMV052YlhCaGJua3RNakF5TkRFeE1UVVdWRWR2ZGxkdVVUTlNOalptYjAwemJWQmhlRFl6Wnc0V1lpMDVkRVpxV2s1U2RFOVRWbTFDV214dlFrWkdRUUFBQUFBQUFEdzJVQlk1VW00eVUwOUJWMUpWUnpOeFRGUlBNbXRZVDI1UkFERnBZM2x3WldGekxYTnVjeTFrWlhabGJHOXdiV1Z1ZEMxc2FXNXJaV1JwYmkxamIyMXdZVzU1TFRJd01qUXhNVEUxRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY05GbUl0T1hSR2FscE9VblJQVTFadFFscHNiMEpHUmtFQUFBQUFBQUE4Tms4V09WSnVNbE5QUVZkU1ZVY3pjVXhVVHpKcldFOXVVUUFCRmxSSGIzWlhibEV6VWpZMlptOU5NMjFRWVhnMk0yY0FBQT09IiwiZklkIjoieFgwVzBKY0JDZGpFUUxvRlpZcjIifx=="
    }
}

The response will contain the next page and a new pagination token. Take the new pagination token and keep going until you run out of results.

caution

You cannot change the query between your initial request and your subsequent request using the pagination token. It will result in unwanted behavior.

Also, each token has an expiration date, so you will not be able to reuse it indefinitely.

Include/Exclude specs

The Include/Exclude field can contains two arrays:

1. include array which lists what needs to be included in the query.
2. exclude array which lists what needs to be excluded from the query.

For instance, when looking for leads, you can include some currentJobTitle and exclude some others:

{
    "currentJobTitle": {
        "include": ["CTO"],
        "exclude": ["Senior engineer"]
    }
}

caution

include and exclude arrays are limited to 200 values per array per field.

Range specs

The Range field contains comparison operators and numerical values only. Some examples are listed below:

{
    "headcount": {
        ">=": 10,
        "<": 20
    }
}

{
    "headcount": {
        ">": 10,
        "<=": 20
    }
}

{
    "headcount": {
        ">": 10,
        "<": 20
    }
}

The operators can be > (greater than), < (less than), >= (greater or equal), '<=' (less or equal).

You are responsible for giving a range that makes sense.