Search Request Parameters
Detailed reference for all supported Profiles US Search API request parameters, including property descriptions, supported operators, data types, and usage guidelines.
| Property | Description | Operators |
|---|---|---|
filter | Add filters to your profiles query. | An object or a list of up to 10 objects. |
filter.last_updated | Filter profiles by the date they were last updated | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.city | Filter by city ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.city_name | Filter by city names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: contains (recommended) is, is not, is one of, is not one of, exists, does not exist |
filter.county | Filter by county codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.county_name | Filter by county names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.employee_count_range | Filter by employee_count_range | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.revenue_bucket | Filter by revenue bucket | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.estimated_wage_p25 | Filter profiles by the estimated wage 25th percentile | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.estimated_wage_p50 | Filter profiles by the estimated wage 25th percentile | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.estimated_wage_p75 | Filter profiles by the estimated wage 25th percentile | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.fips | Filter by fip codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.fips_name | Filter by fip names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.is_fortune100 | Filter by if company is Fortune 100 | This is an optional attribute. |
filter.is_fortune1000 | Filter by if company is Fortune 1000 | This is an optional attribute. |
filter.is_fortune500 | Filter by if company is Fortune 500 | This is an optional attribute. |
filter.profile_tags | Filter by profile tags | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.profile_last_seen_date | Filter by profile last seen date | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.isced_max | Filter by highest isced codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.isced_max_name | Filter by highest isced names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_country | Filter by country ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_country_name | Filter by country names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_metro | Filter by metro ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_metro_name | Filter by metro names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_admin_area_1 | Filter by admin area 1 ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_admin_area_1_name | Filter by admin area 1 names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_admin_area_2 | Filter by admin area 2 ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.laa_admin_area_2_name | Filter by admin area 2 names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.max_edulevels | Filter by max edulevels | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.max_edulevels_name | Filter by max edulevels names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc2 | Filter by Lightcast level 2 SOC codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc2_name | Filter by Lightcast level 2 SOC names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc3 | Filter by Lightcast level 3 SOC codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc3_name | Filter by Lightcast level 3 SOC names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc4 | Filter by Lightcast level 4 SOC codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc4_name | Filter by Lightcast level 4 SOC names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc5 | Filter by Lightcast level 5 SOC codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.soc5_name | Filter by Lightcast level 5 SOC names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info | Filter by personal information | This is an optional attribute. Object containing filter criteria for personal information fields. |
filter.personal_info.has_phone | Filter by presence of phone | This is an optional attribute. |
filter.personal_info.has_email | Filter by presence of email | This is an optional attribute. |
filter.personal_info.name | Filter by profile name | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.first_name | Filter by profile first name | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.last_name | Filter by profile last name | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.email | Filter by email | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.phone | Filter by phone | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.phone_type_name | Filter by phone type name | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.phone_type_ddi | Filter by presence of DDI phone | This is an optional attribute. |
filter.personal_info.email_type_name | Filter by email type name | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.personal_info.profile_url_source_name | Filter by profile URL source name | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations | Filter by educational credentials | This is an optional attribute. |
filter.educations.grad_year | Filter by graduation year | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.educations.schools | Filter by schools | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.schools_name | Filter by schools names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.cip2 | Filter by cip2 codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.cip2_name | Filter by cip2 names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.cip4 | Filter by cip4 codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.cip4_name | Filter by cip4 names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.cip6 | Filter by cip6 codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.cip6_name | Filter by cip6 names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.edulevels | Filter by edulevels | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.edulevels_name | Filter by edulevels names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.isced | Filter by isced codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.isced_name | Filter by isced names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.educations.schools_ipeds | Filter by schools ipeds | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.employment_history | Filter by employment history | This is an optional attribute. |
filter.employment_history.company_all | Filter by normalized employment history codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.employment_history.company_all_name | Filter by normalized employment history names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.employment_history.title_all | Filter by normalized employment history title codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.employment_history.title_all_name | Filter by normalized employment history title names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.title | Filter by job title codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.title_name | Filter by job title names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.onet | Filter by Lightcast O*NET codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.onet_name | Filter by Lightcast O*NET names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.company | Filter by normalized company codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.company_name | Filter by normalized company names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.company_v2 | Filter by normalized company codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.company_name_v2 | Filter by normalized company names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.state | Filter by state codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.state_name | Filter by state names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.msa | Filter by Lightcast MSA codes (metro or micro) | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.msa_name | Filter by Lightcast MSA names (metro or micro) | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_specialized_occupation | Filter by specialized occupation ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_specialized_occupation_name | Filter by specialized occupation names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_occupation | Filter by occupation ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_occupation_name | Filter by occupation names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_occupation_group | Filter by occupation groups ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_occupation_group_name | Filter by occupation groups names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_career_area | Filter by career areas ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.lot_career_area_name | Filter by career area names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.skills | Filter by skill codes (any skill type) | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.skills_name | Filter by skill names (any skill type) | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.gender | Filter by gender codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.gender_name | Filter by gender names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.years_with_most_recent_company | Filter by years with most recent company | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist• is• is not• is one of• is not one of |
filter.most_recent_company | Filter by most recent company | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.years_in_current_role | Filter by years in current role | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist• is• is not• is one of• is not one of |
filter.moves_in_most_recent_company | Filter by moves in most recent company | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist• is• is not• is one of• is not one of |
filter.most_recent_company_start_date | Filter by most recent company start date | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.most_recent_company_end_date | Filter by most recent company end date | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.previous_company | Filter by previous company | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.previous_company_start_date | Filter by previous company start date | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.previous_company_end_date | Filter by previous company end date | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist |
filter.years_of_work_history | Filter by years of work history | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.years_of_experience_in_occupation | Filter by years of experience in occupation | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.years_with_previous_company | Filter by years with previous company | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.moves_in_previous_company | Filter by moves in previous company | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: after, before, exists, does not exist, is, is not, is one of, is not one of |
filter.skill_categories | Filter by skill category ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.skill_categories_name | Filter by skill category names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.skill_subcategories | Filter by skill subcategory ids | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.skill_subcategories_name | Filter by skill subcategory names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics2 | Filter by normalized 2-digit company NAICS codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics2_name | Filter by normalized 2-digit company NAICS code names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics3 | Filter by normalized 3-digit company NAICS codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics3_name | Filter by normalized 3-digit company NAICS code names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics4 | Filter by normalized 4-digit company NAICS codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics4_name | Filter by normalized 4-digit company NAICS code names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics5 | Filter by normalized 5-digit company NAICS codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics5_name | Filter by normalized 5-digit company NAICS code names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics6 | Filter by normalized 6-digit company NAICS codes | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.naics6_name | Filter by normalized 6-digit company NAICS code names | This is an optional attribute. Array of objects. Each object must contain: operator, value Supported operators: is, is not, is one of, is not one of, exists, does not exist |
filter.keywords | Filter by keywords | This is an optional attribute. Object containing keyword query and options for keyword matching. |
filter.keywords.query | - | Keyword(s) by which to filter profiles |
filter.keywords.current_job_only | Type of keyword search to run | This is an optional attribute. Default: false |
filter.keywords.type | Type of keyword search to run | This is an optional attribute. Must be one of these values: "or", "and", "phrase", "expression"Default: "or" |
limit | Limit the number of ranked items returned | This is an optional attribute. Minimum: 1Maximum: 100Default: 10 |
offset | Zero based offset used for paginating search profiles | This is an optional attribute. Search Profiles can only be viewed up to the 10,000th profile matching your filter (i.e. offset + limit <= 10,000).Minimum: 0Default: 0 |