Search Filters: Base Employee API
Data type:
Query type:
URL:
Base Employee
Coresignal's custom filters
https://api.coresignal.com/cdapi/v2/employee_base/search/filter
Overview
Explore the available filters, their potential applications, and helpful tips.
Use the endpoint to discover employee IDs. This endpoint offers a less complex user experience than the /v2/employee_base/search/es_dsl endpoint.
If you prefer uncomplicated queries, opt for this endpoint. Below are details about filter explanations and how to use them.
Endpoint structure
{
"full_name": "string",
"headline": "string",
"location": "string",
"industry": "string",
"summary": "string",
"created_at_gte": "string",
"created_at_lte": "string",
"updated_at_gte": "string",
"updated_at_lte": "string",
"deleted": true,
"country": "string",
"skill": "string",
"certification_title": "string",
"experience_title": "string",
"experience_company_name": "string",
"experience_company_exact_name": "string",
"experience_company_website_url": "string",
"experience_company_website_exact_url": "string",
"experience_company_professional_network_url": "string",
"experience_company_industry": "string",
"experience_company_size": "string",
"experience_company_employees_count_gte": 0,
"experience_company_employees_count_lte": 0,
"experience_date_from": "string",
"experience_date_to": "string",
"experience_description": "string",
"experience_deleted": true,
"experience_company_id": 0,
"active_experience": true,
"keyword": "string",
"education_institution_name": "string",
"education_institution_exact_name": "string",
"education_program_name": "string",
"education_description": "string",
"education_date_from": "string",
"education_date_to": "string",
"education_institution_professional_network_url": "string",
"is_hidden": true
}
Filter list
full_name
full_name
String
Employee's name
Use it to find records based on the employee's name, surname, or full name.
Example input:
Example output with corresponding fields in the output data:
headline
headline
String
Employee's job title (Employee's profile headline)
Use it to find records based on the profile headline (title). Available operators:
AND(both keywords need to be present)OR(one of the two input values)
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
Use "\"{keyword}\"" format to find exact matches.
location
location
String
Employee's location
Use it to find records based on location. Use states, cities, and countries.
Example input:
Example output:
industry
industry
String
Associated industry
Note: not directly related to any particular work experience
Use to find employee records based on the associated industry. Search based on the available list of industries. Available operators:
OR(one of the two input values).
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Possible input values can be found in general Search filters topic.
summary
summary
String
Education/work experience summary
Use it to find employee records based on the education/work experience summary. Available operators:
AND(both keywords need to be present)OR(one of the two input values)
You can use the operator * to finish the keyword.
For example, "py" will return results with py visible in them. Py* will return results with the completed word, e.g., Python.
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
created_at_gte
created_at_gte
String
Date and time when the record was created in our database
Find employee records based on creation date.
Use the YYYY-MM-DD hh:mm:ss date format.
The output value will be greater than or equal to the input value.
Example input:
Example output:
created_at_lte
created_at_lte
String
Date and time when the record was created in our database
Find employee records based on creation date.
Use the YYYY-MM-DD hh:mm:ss date format.
The output value will be less than or equal to the input value.
Example input:
Example output:
updated_at_gte
updated_at_gte
String
Date and time when the record was last updated
Find employee records based on the last update date.
Use the YYYY-MM-DD hh:mm:ss date format.
The output value will be greater than or equal to the input value.
Example input:
Example output:
updated_at_lte
updated_at_lte
String
Date and time when the record was last updated
Find employee records based on the last update date.
Use the YYYY-MM-DD hh:mm:ss date format.
The output value will be less than or equal to the input value.
Example input:
Example output:
deleted
deleted
Boolean
Marks record's public availability
Use it to see employee records that are deleted or private.
Use the value true to include deleted/private profiles or false to exclude such profiles from your search.
Tip: Combine with other filters using relevant keywords.
Possible input values:
Example output:
country
country
String
Country the employee is based in, parsed by us from the location value
Use it to find employee records based on location. Search based on the parsed location list. Available operators:
OR(one of the two input values).
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Possible input values can be found in general Search filters topic.
skill
skill
String
Employee's skills
Note: Professional network has removed Skills from public profiles since April 2018
Use it to find employee records based on relevant skills. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present)*(choose all profiles that have skill records)
You can use a part of the keyword with the operator *. In this case, you will see words that start with py.
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
Use "\"{keyword}\"" format to find exact matches.
certification_title
certification_title
String
Employee's certifications
Use it to find employee records based on held certifications. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present)*(choose all profiles that have certification records).
You can use a part of the keyword with the operator *. In this case, you will see words that start with py as, the certification name.
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
Use "\"{keyword}\"" format to find exact matches.
experience_title
experience_title
String
Job title in the experience record
Use it to find employee records based on relevant work experience. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present)*(choose all profiles that have experience records).
You can use a part of the keyword with the operator *. In this case, you will see words that start with py as the experience title.
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
Use "\"{keyword}\"" format to find exact matches.
experience_company_name
experience_company_name
String
Current or previous workplace
Use it to find employee records based on the relevant workplace. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present)*(choose all profiles with the company name in the experience record).
You can use phrases or words you want to see in the company name.
For example, using IT will find all employee profiles with experience in a company using "IT" in their name.
Example input:
Use "(first_company) OR/AND (second_company)" when including several company names in the query.
Example output:
experience_company_exact_name
experience_company_exact_name
String
Exact name of the current or previous workplace
Use it to find employee records based on the relevant workplace.
The output value will match the provided company name (e.g., both Example and example will work for the filter).
The filter returns an exact match with the input value.
For example, if you input M as the value to look for, you get all employee profiles with a company named "M" listed on their profile.
Example output:
experience_company_website_url
experience_company_website_url
String
Website of the current or previous workplace
Use it to find employee records based on the relevant workplace. Possible URL formats:
www.example.com
https://www.example.com.
Example input:
Example output:
experience_company_website_exact_url
experience_company_website_exact_url
String
The exact website of the current or previous workplace
Use it to find employee records based on the relevant workplace. Possible URL formats:
www.example.com
https://www.example.com .
Example input:
Example output:
experience_company_professional_network_url
experience_company_professional_network_url
String
Professional network profile of the current or previous workplace
Use to find employee records based on the relevant workplace.
Note: only the Professional network company profile URL or shorthand name is accepted.
Example input:
Example output:
experience_company_industry
experience_company_industry
String
Workplace industry
Search based on the available list of industries. Available operators:
OR(one or the other keyword is present in the data).
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Possible input values for industry can be found in general Search filters topic.
experience_company_size
experience_company_size
String
Workplace's headcount (previous or current)
Find employee records based on the headcount of the current/previous workplace. Available operators:
OR(one or the other keyword is present in the data).
Use "(size) OR (size)" if you are searching for words in a phrase and want them to be interpreted together.
Possible input values for size can be found in general Search filters topic.
experience_company_employees_count_gte
experience_company_employees_count_gte
Integer
Workplace's headcount
Find employee records based on the headcount in the current or previous workplace. The output value will be greater than or equal to the input value.
Example input:
Example output:
experience_company_employees_count_lte
experience_company_employees_count_lte
Integer
Workplace's headcount
Find employee records based on the headcount in the current or previous workplace. The output value will be less than or equal to the input value.
Example input:
Example output:
experience_date_from
experience_date_from
String
Employment start date
Appears if
active_experience
is TRUE.
Use it to find employee records based on employment start date/duration.
Use the month yyyy or yyyy date format.
The output value will be greater than or equal to the input value.
If you prefer to see the date_from field as null in the profile data, use the value 1000 with the filter.
Alternatively, if you want the field to be!=null and don't have a date requirement, use the value 1001 with the filter.
Example input:
Example output:
experience_date_to
experience_date_to
String
Employment end date
Appears if active_experience
is TRUE.
Use it to find employee records based on employment end date/duration.
Use the month yyyy or yyyydate format.
The output value will be less than or equal to the input value.
If you prefer to see the date_to field as null in the profile data, use the value 1000 with the filter.
Alternatively, if you want the field to be !=null and don't have a date requirement, use the value 1001 with the filter.
Example input:
Example output:
experience_description
experience_description
String
Keywords visible in the experience description
Use it to find employee records using relevant keywords. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present).
Example input:
Example output:
experience_deleted
experience_deleted
Boolean
Marks record's public availability
Use it to see experience records that are deleted or private.
Use the value true to include deleted/private records or false to exclude such records from your search.
Tip: combine it with other experience filters to search for relevant records.
Example input:
Example output:
experience_company_id
experience_company_id
Integer
Company identification key in our database
Use it to find employee records based on relevant workplaces. Use the acquired company IDs to match companies with employee profiles.
Example input:
Example output:
active_experience
active_experience
Boolean
Marks if the person is currently working
Use it to find current employees. Note: only true value is usable with the filter.
Tip: combine it with other experience filters to search for relevant records.
Example input:
Example output:
keyword
keyword
String
Keywords in different profile sections.
Fields included in search: summary; industry; skill; experience_title; experience_description
Use the find employee profiles that contain relevant keywords. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present).
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
Use "\"{keyword}\"" format to find exact matches.
education_institution_name
education_institution_name
String
Education institution listed on the employee's profile.
Use to find employee records according to their education. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present)
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
education_institution_exact_name
education_institution_exact_name
String
The exact name of the education institution listed on the employee's profile
Use to find employee records according to their education. Exact name = the institution name listed on the employee's profile.
Example input:
Example output:
education_program_name
education_program_name
String
Study program the employee was enrolled in
Use it to find employee records based on study programs.
The full program name is not required - the filter will match the records that include the required word or phrase (e.g., it).
Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present).
Example input:
Use "(first phrase) OR (second phrase)" if you are searching for words in a phrase and want them to be interpreted together.
Example output:
Use "\"{keyword}\"" format to find exact matches.
education_description
education_description
String
Education experience description
Use it to find employee records with relevant education. Available operators:
AND(both keywords need to be present)OR(one or the other keyword is present).
The keyword will be matched in the data.
For example, if you input py you will get results where py is present in the education description but not Python.
Example input:
Example output:
education_date_from
education_date_from
String
Enrolment date
Use it to find employee records based on the education start date/duration.
Use the month yyyy or yyyy date format.
The output value will be greater than or equal to the input value.
If you prefer to see the date_from field as null in the profile data, use the value 1000 with the filter.
Alternatively, if you want the field to be!=null and don't have a date requirement, use the value 1001 with the filter.
Example input:
Example output:
education_date_to
education_date_to
String
Graduation date
Use it to find employee records based on the education end date/duration.
Use the month yyyy or yyyy date format.
The output value will be less than or equal to the input value.
If you prefer to see the date_from field as null in the profile data, use the value 1000 with the filter.
Alternatively, if you want the field to be !=null and don't have a date requirement, use the value 1001 with the filter.
Example input:
Example output:
Last updated
Was this helpful?