Overview

The Query Builder is a free, no-code tool in the API Dashboard for constructing queries for the Person and Company Search APIs. It enables you to:

• View the results in the API Explorer Tool using the generated queries
• View real-time profile match counts without using API credits
• Generates code examples for executing and retrieving profile results 

Building a query

1. Choose the data type Person or Company you want to query
   1. If you are querying for Person data, you must also select which dataset you want to use
   2. We recommend selecting the resume dataset as it covers most use cases and contains the least duplication
      
2. Select the Add Rule button to add a rule to determine which profiles should be returned
3. A dropdown menu will appear with a list of available fields based on the selected data type
   1. Input parameters correspond to fields from the Person or Company datasets
      
4. Once the field is selected, choose the [Matching Logic] you want to use
   
5. Next, define the field value for the rule
   1. Many fields like as location_name, job_title, skills, industry, education.degrees, education.majors, and more will autocomplete as you type
      
6. For more complex queries, you can use the Add Group feature
   1. Select the logical operator (AND, OR) to determine how the rules within the group will be combined.
   2. For example, the following query will return profiles that have a work_email AND their location_region is California or New York
      
7. Finally click the Search button to generate:
   1. A count of profiles that match your query
   2. An option to explore the results with the Copy & Explore button
   3. Working code snippets that reflect your query.
      1. Code snippets are provided in PDL's JS SDK, Python SDK, Ruby SDK, and Go SDK, as well as pure Python, cURL, SQL, and ESQuery

Example Query

In this scenario, a recruiter wants to find the following:

• Senior Software Engineers with skills in Python
• UX Designers with skills in Figma
• The candidates must live in the United States or Canada
• They must have a personal email or mobile phone for contact

By utilizing the Query Builder tool, the recruiter can construct a query that meets these specific criteria. Check out the video below for a detailed walkthrough.

View the results using the API Explorer Tool

This video demonstrates how to view the results of a Query Builder search by clicking the Copy & Explore button.

Matching logic options

Logic types

There are three types of dropdown menus depending on whether or not the field supports autofill or it supports a number range

Field with autofill

Field without autofill

Number range

Definitions

• = (Equals): This matching logic is used to find exact matches for the entered value(s)
  • For example, if you select the number_funding_rounds field and set the matching logic as "=", entering 1, it will match profiles that have had exactly 1 funding round
• != (Not Equals): This logic is used to exclude profiles that have a specific value
  • e.g. if you set the matching logic as "!=" and enter "2023" for the founded field, it will match companies that were founded in any year other than 2023
• beginsWith: This logic is used to find profiles where a particular field starts with the entered value(s)
  • e.g. if you set the matching logic as "beginsWith" for the first_name field and enter "John" it will match profiles with first names like "John," "Johnson," or "Johnathan."
• endsWith: This logic is used to find profiles where a particular field ends with the entered value(s)
  • e.g. if you set the matching logic as "endsWith" for the emails field and enter "@gmail.com", it will match profiles with email addresses ending in "@gmail.com"
• doesNotBeginWith: Exclude profiles where a particular field does not start with the entered value(s)
  • e.g. if you set the matching logic as "doesNotBeginWith" for the website field and enter "ABC", companies with websites beginning with "ABC" will be excluded
• doesNotEndWith: This logic is used to exclude profiles where a particular field does not end with the entered value(s)
  • e.g. if you set the matching logic as "doesNotEndWith" for the personal_emails field and enter "@yahoo.com", profiles with email addresses ending in "@yahoo.com" will be excluded.horn
• null: Filters profiles if the selected field is empty or null
  • e.g. if you set the matching logic as null for the mobile_phone field, it will match profiles that do not contain a mobile phone number
• notNull: This logic is used to find profiles where a particular field is not empty or null
  • e.g. if you set the matching logic as notNull for the work_email field, it will match profiles that contain a work email
• in: Match profiles where a particular field's value is contained within a list of provided values
  • e.g. if you set the matching logic as "in" for the birth_year field and enter "1990, 1993", it will match profiles with a birth year in 1990 OR 1993
• notIn: Exclude profiles where a particular field's value is present in a list of provided values
  • e.g. if you set the matching logic as "notIn" for the birth_year field and enter "1990, 1993", it will match profiles with a birth year that is NOT 1990 OR 1993
    
    

Feedback

Is there a missing feature you'd like to see? We want to hear from you! 

Submit a feature request or vote on existing feature requests here: People Data Labs Roadmap