People Finder GPT
People Finder GPT · Acciones GPT
Generate a person search
Retrieves a person search url to preview and download results.
POST /v2/search_urlGetSearchUrlV2Given a valid lucene boolean query generate a unique search url and message
POST /search_urlGetSearchUrlGenerate a search url and message based on a valid Elasticsearch Query
Esquema original API
{
"openapi": "3.1.0",
"info": {
"title": "Generate a person search",
"description": "Retrieves a person search url to preview and download results.",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://pf-gpt.statespace.solutions/api"
}
],
"paths": {
"/v2/search_url": {
"post": {
"description": "Given a valid lucene boolean query generate a unique search url and message",
"operationId": "GetSearchUrlV2",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchV2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Expected response to a valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"deprecated": false
}
},
"/search_url": {
"post": {
"description": "Generate a search url and message based on a valid Elasticsearch Query",
"operationId": "GetSearchUrl",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Search"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Expected response to a valid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponse"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"deprecated": true
}
}
},
"components": {
"schemas": {
"PDLSearch": {
"type": "object",
"required": [
"search"
],
"properties": {
"search": {
"type": "string",
"description": "A Elasticsearch SQL query of the format SELECT * FROM person WHERE XXX, where XXX is a standard Elasticsearch SQL boolean query involving PDL fields. Any use of column selections or the LIMIT keyword will be ignored."
}
}
},
"Email": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The full parsed email"
},
"type": {
"type": "string",
"enum": [
"professional",
"personal"
],
"description": "The type of email either current_professional, professional, personal or null"
}
}
},
"VersionStatus": {
"type": "object",
"properties": {
"contains": {
"type": "array",
"description": "List of IDs merged into this record since the last release",
"items": {
"type": "string"
}
},
"current_version": {
"type": "string",
"description": "Current version of the data"
},
"previous_version": {
"type": "string",
"description": "Previous version of the data"
},
"status": {
"type": "string",
"enum": [
"added",
"unchanged",
"updated"
],
"description": "Explains what happened to this record between the previous release and the current release"
}
}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "PDL persistent ID"
},
"full_name": {
"type": "string",
"description": "The first and the last name fields appended with a space"
},
"first_name": {
"type": "string",
"description": "A person's first name"
},
"middle_initial": {
"type": "string",
"description": "A person's middle initial"
},
"middle_name": {
"type": "string",
"description": "A person's middle name"
},
"last_initial": {
"type": "string",
"description": "A person's last initial"
},
"last_name": {
"type": "string",
"description": "A person's last name"
},
"gender": {
"type": "string",
"enum": [
"male",
"female"
],
"description": "The person's gender"
},
"birth_year": {
"type": "string",
"format": "date",
"description": "Approximated birth date associated with this person profile. If a profile has a birth_date, the birth_data_fuzzy field will match"
},
"birth_date": {
"type": "string",
"format": "date",
"description": "Birth date associated with this person profile"
},
"linkedin_url": {
"type": "string",
"format": "url",
"description": "Main linkedin profile for this record based on source agreement"
},
"linkedin_username": {
"type": "string",
"description": "Main linkedin username for this record based on source agreement"
},
"linkedin_id": {
"type": "string",
"description": "Main linkedin profile id for this record based on source agreement"
},
"facebook_url": {
"type": "string",
"format": "url",
"description": "facebook profile"
},
"facebook_username": {
"type": "string",
"description": "facebook username"
},
"facebook_id": {
"type": "string",
"description": "persistent facebook id associated with a person's facebook profile"
},
"twitter_url": {
"type": "string",
"format": "url",
"description": "Twitter URL"
},
"twitter_username": {
"type": "string",
"description": "Twitter Username"
},
"github_url": {
"type": "string",
"format": "url",
"description": "Main github profile for this record based on source agreement"
},
"github_username": {
"type": "string",
"description": "Main github profile username for this record based on source agreement"
},
"work_email": {
"type": "string",
"description": "Current Professional email"
},
"personal_emails": {
"type": "array",
"description": "List of all emails tagged as type = personal",
"items": {
"type": "string"
}
},
"mobile_phone": {
"type": "string",
"description": "Highly confident direct dial mobile phone associated with this person"
},
"industry": {
"type": "string",
"description": "The most relevant industry for this record based primarily on their tagged personal industries and secondarily on the industries of the companies that they have worked for"
},
"job_title": {
"type": "string",
"description": "A person's current job title"
},
"job_title_role": {
"type": "string",
"enum": [
"customer_service",
"design",
"education",
"engineering",
"finance",
"health",
"human_resources",
"legal",
"marketing",
"media",
"operations",
"public_relations",
"real_estate",
"sales",
"trades"
],
"description": "A person's current job title derived role"
},
"job_title_sub_role": {
"type": "string",
"enum": [
"accounting",
"accounts",
"brand_marketing",
"broadcasting",
"business_development",
"compensation",
"content_marketing",
"customer_success",
"data",
"dental",
"devops",
"doctor",
"editorial",
"education_administration",
"electrical",
"employee_development",
"events",
"fitness",
"graphic_design",
"information_technology",
"investment",
"journalism",
"judicial",
"lawyer",
"logistics",
"mechanical",
"media_relations",
"network",
"nursing",
"office_management",
"paralegal",
"pipeline",
"product",
"product_design",
"product_marketing",
"professor",
"project_engineering",
"project_management",
"property_management",
"quality_assurance",
"realtor",
"recruiting",
"researcher",
"security",
"software",
"support",
"systems",
"tax",
"teacher",
"therapy",
"video",
"web",
"web_design",
"wellness",
"writing"
],
"description": "A person's job title derived subrole. Each subrole maps to a role"
},
"job_title_levels": {
"type": "string",
"enum": [
"unpaid",
"training",
"entry",
"manager",
"senior",
"partner",
"director",
"vp",
"owner",
"cxo"
],
"description": "A person's current job title derived levels"
},
"job_company_id": {
"type": "string",
"description": "A person's current company's PDL ID"
},
"job_company_name": {
"type": "string",
"description": "A person's current company's name"
},
"job_company_website": {
"type": "string",
"description": "A person's current company's website"
},
"job_company_size": {
"type": "string",
"enum": [
"1-10",
"11-50",
"51-200",
"201-500",
"501-1000",
"1001-5000",
"5001-10000",
"10001+"
],
"description": "A person's current company's size range"
},
"job_company_founded": {
"type": "string",
"format": "date",
"description": "A person's current company's founded date"
},
"job_company_industry": {
"type": "string",
"enum": [
"accounting",
"airlines/aviation",
"alternative dispute resolution",
"alternative medicine",
"animation",
"apparel & fashion",
"architecture & planning",
"arts and crafts",
"automotive",
"aviation & aerospace",
"banking",
"biotechnology",
"broadcast media",
"building materials",
"business supplies and equipment",
"capital markets",
"chemicals",
"civic & social organization",
"civil engineering",
"commercial real estate",
"computer & network security",
"computer games",
"computer hardware",
"computer networking",
"computer software",
"construction",
"consumer electronics",
"consumer goods",
"consumer services",
"cosmetics",
"dairy",
"defense & space",
"design",
"e-learning",
"education management",
"electrical/electronic manufacturing",
"entertainment",
"environmental services",
"events services",
"executive office",
"facilities services",
"farming",
"financial services",
"fine art",
"fishery",
"food & beverages",
"food production",
"fund-raising",
"furniture",
"gambling & casinos",
"glass, ceramics, & concrete",
"government administration",
"government relations",
"graphic design",
"health, wellness and fitness",
"higher education",
"hospital & health care",
"hospitality",
"human resources",
"import and export",
"individual & family services",
"industrial automation",
"information services",
"information technology and services",
"insurance",
"international affairs",
"international trade and development",
"internet",
"investment banking",
"investment management",
"judiciary",
"law enforcement",
"law practice",
"legal services",
"legislative office",
"leisure, travel, & tourism",
"libraries",
"logistics and supply chain",
"luxury goods & jewelry",
"machinery",
"management consulting",
"maritime",
"market research",
"marketing and advertising",
"mechanical or industrial engineering",
"media production",
"medical devices",
"medical practice",
"mental health care",
"military",
"mining & metals",
"motion pictures and film",
"museums and institutions",
"music",
"nanotechnology",
"newspapers",
"non-profit organization management",
"oil & energy",
"online media",
"outsourcing/offshoring",
"package/freight delivery",
"packaging and containers",
"paper & forest products",
"performing arts",
"pharmaceuticals",
"philanthropy",
"photography",
"plastics",
"political organization",
"primary/secondary education",
"printing",
"professional training & coaching",
"program development",
"public policy",
"public relations and communications",
"public safety",
"publishing",
"railroad manufacture",
"ranching",
"real estate",
"recreational facilities and services",
"religious institutions",
"renewables & environment",
"research",
"restaurants",
"retail",
"security and investigations",
"semiconductors",
"shipbuilding",
"sporting goods",
"sports",
"staffing and recruiting",
"supermarkets",
"telecommunications",
"textiles",
"think tanks",
"tobacco",
"translation and localization",
"transportation/trucking/railroad",
"utilities",
"venture capital & private equity",
"veterinary",
"warehousing",
"wholesale",
"wine and spirits",
"wireless",
"writing and editing"
],
"description": "A person's current company's industry"
},
"job_company_linkedin_url": {
"type": "string",
"description": "A person's current company's linkedin url"
},
"job_company_linkedin_id": {
"type": "string",
"description": "A person's current company's linkedin id"
},
"job_company_facebook_url": {
"type": "string",
"description": "A person's current company's facebook url"
},
"job_company_twitter_url": {
"type": "string",
"description": "A person's current company's twitter url"
},
"job_company_location_name": {
"type": "string",
"description": "A person's current company's HQ canonical location"
},
"job_company_location_locality": {
"type": "string",
"description": "A person's current company's HQ locality"
},
"job_company_location_metro": {
"type": "string",
"enum": [
"abilene, texas",
"akron, ohio",
"albany, georgia",
"albany, new york",
"albany, oregon",
"albuquerque, new mexico",
"alexandria, louisiana",
"allentown, pennsylvania",
"altoona, pennsylvania",
"amarillo, texas",
"ames, iowa",
"anchorage, alaska",
"ann arbor, michigan",
"anniston, alabama",
"appleton, wisconsin",
"asheville, north carolina",
"athens, georgia",
"atlanta, georgia",
"atlantic city, new jersey",
"auburn, alabama",
"augusta, georgia",
"austin, texas",
"bakersfield, california",
"baltimore, maryland",
"bangor, maine",
"barnstable town, massachusetts",
"baton rouge, louisiana",
"battle creek, michigan",
"bay city, michigan",
"beaumont, texas",
"bellingham, washington",
"billings, montana",
"binghamton, new york",
"birmingham, alabama",
"bismarck, north dakota",
"blacksburg, virginia",
"bloomington, illinois",
"bloomington, indiana",
"boise city, idaho",
"boston, massachusetts",
"boulder, colorado",
"bowling green, kentucky",
"bremerton, washington",
"bridgeport, connecticut",
"brownsville, texas",
"buffalo, new york",
"burlington, north carolina",
"burlington, vermont",
"canton, ohio",
"cape coral, florida",
"cape girardeau, missouri",
"carbondale, illinois",
"carson city, nevada",
"casper, wyoming",
"cedar rapids, iowa",
"champaign, illinois",
"charleston, south carolina",
"charleston, west virginia",
"charlotte, north carolina",
"charlottesville, virginia",
"chattanooga, tennessee",
"cheyenne, wyoming",
"chicago, illinois",
"chico, california",
"cincinnati, ohio",
"clarksville, tennessee",
"cleveland, ohio",
"cleveland, tennessee",
"coeur d'alene, idaho",
"college station, texas",
"colorado springs, colorado",
"columbia, missouri",
"columbia, south carolina",
"columbus, georgia",
"columbus, indiana",
"columbus, ohio",
"corpus christi, texas",
"corvallis, oregon",
"crestview, florida",
"cumberland, maryland",
"dallas, texas",
"dalton, georgia",
"danville, illinois",
"davenport, iowa",
"dayton, ohio",
"decatur, alabama",
"decatur, illinois",
"deltona, florida",
"denver, colorado",
"des moines, iowa",
"detroit, michigan",
"district of columbia",
"dothan, alabama",
"dover, delaware",
"dubuque, iowa",
"duluth, minnesota",
"durham, north carolina",
"eau claire, wisconsin",
"el centro, california",
"el paso, texas",
"elizabethtown, kentucky",
"elkhart, indiana",
"elmira, new york",
"enid, oklahoma",
"erie, pennsylvania",
"eugene, oregon",
"evansville, indiana",
"fairbanks, alaska",
"fargo, north dakota",
"farmington, new mexico",
"fayetteville, arkansas",
"fayetteville, north carolina",
"flagstaff, arizona",
"flint, michigan",
"florence, alabama",
"florence, south carolina",
"fond du lac, wisconsin",
"fort collins, colorado",
"fort smith, arkansas",
"fort wayne, indiana",
"fresno, california",
"gadsden, alabama",
"gainesville, florida",
"gainesville, georgia",
"goldsboro, north carolina",
"grand forks, north dakota",
"grand island, nebraska",
"grand junction, colorado",
"grand rapids, michigan",
"grants pass, oregon",
"great falls, montana",
"greeley, colorado",
"green bay, wisconsin",
"greensboro, north carolina",
"greenville, north carolina",
"greenville, south carolina",
"gulfport, mississippi",
"hagerstown, maryland",
"hanford, california",
"harrisburg, pennsylvania",
"harrisonburg, virginia",
"hartford, connecticut",
"hattiesburg, mississippi",
"hickory, north carolina",
"hilton head island, south carolina",
"hinesville, georgia",
"hot springs, arkansas",
"houma, louisiana",
"houston, texas",
"huntington, west virginia",
"huntsville, alabama",
"idaho falls, idaho",
"indianapolis, indiana",
"iowa city, iowa",
"ithaca, new york",
"jackson, michigan",
"jackson, mississippi",
"jackson, tennessee",
"jacksonville, florida",
"jacksonville, north carolina",
"janesville, wisconsin",
"jefferson city, missouri",
"johnson city, tennessee",
"johnstown, pennsylvania",
"jonesboro, arkansas",
"joplin, missouri",
"kahului, hawaii",
"kalamazoo, michigan",
"kankakee, illinois",
"kansas city, missouri",
"kennewick, washington",
"killeen, texas",
"kingsport, tennessee",
"kingston, new york",
"knoxville, tennessee",
"kokomo, indiana",
"la crosse, wisconsin",
"lafayette, indiana",
"lafayette, louisiana",
"lake charles, louisiana",
"lake havasu city, arizona",
"lakeland, florida",
"lancaster, pennsylvania",
"lansing, michigan",
"laredo, texas",
"las cruces, new mexico",
"las vegas, nevada",
"lawrence, kansas",
"lawton, oklahoma",
"lebanon, pennsylvania",
"lewiston, idaho",
"lewiston, maine",
"lexington, kentucky",
"lima, ohio",
"lincoln, nebraska",
"little rock, arkansas",
"logan, utah",
"longview, texas",
"longview, washington",
"los angeles, california",
"louisville, kentucky",
"lubbock, texas",
"lynchburg, virginia",
"macon, georgia",
"madera, california",
"madison, wisconsin",
"manchester, new hampshire",
"manhattan, kansas",
"mankato, minnesota",
"mansfield, ohio",
"mcallen, texas",
"medford, oregon",
"memphis, tennessee",
"merced, california",
"miami, florida",
"michigan city, indiana",
"midland, michigan",
"midland, texas",
"milwaukee, wisconsin",
"minneapolis, minnesota",
"missoula, montana",
"mobile, alabama",
"modesto, california",
"monroe, louisiana",
"monroe, michigan",
"montgomery, alabama",
"morgantown, west virginia",
"morristown, tennessee",
"mount vernon, washington",
"muncie, indiana",
"muskegon, michigan",
"myrtle beach, south carolina",
"napa, california",
"naples, florida",
"nashville, tennessee",
"new bern, north carolina",
"new haven, connecticut",
"new orleans, louisiana",
"new york, new york",
"north port, florida",
"norwich, connecticut",
"ocala, florida",
"odessa, texas",
"ogden, utah",
"oklahoma city, oklahoma",
"olympia, washington",
"omaha, nebraska",
"orlando, florida",
"oshkosh, wisconsin",
"owensboro, kentucky",
"oxnard, california",
"palm bay, florida",
"panama city, florida",
"parkersburg, west virginia",
"pensacola, florida",
"peoria, illinois",
"philadelphia, pennsylvania",
"phoenix, arizona",
"pine bluff, arkansas",
"pittsburgh, pennsylvania",
"pittsfield, massachusetts",
"pocatello, idaho",
"port st. lucie, florida",
"portland, maine",
"portland, oregon",
"poughkeepsie, new york",
"prescott valley, arizona",
"providence, rhode island",
"provo, utah",
"pueblo, colorado",
"punta gorda, florida",
"racine, wisconsin",
"raleigh, north carolina",
"rapid city, south dakota",
"reading, pennsylvania",
"redding, california",
"reno, nevada",
"richmond, virginia",
"riverside, california",
"roanoke, virginia",
"rochester, minnesota",
"rochester, new york",
"rockford, illinois",
"rocky mount, north carolina",
"rome, georgia",
"sacramento, california",
"saginaw, michigan",
"salem, oregon",
"salinas, california",
"salisbury, maryland",
"salt lake city, utah",
"san angelo, texas",
"san antonio, texas",
"san diego, california",
"san francisco, california",
"san jose, california",
"san luis obispo, california",
"santa cruz, california",
"santa fe, new mexico",
"santa maria, california",
"santa rosa, california",
"savannah, georgia",
"scranton, pennsylvania",
"seattle, washington",
"sebastian, florida",
"sheboygan, wisconsin",
"sherman, texas",
"shreveport, louisiana",
"sierra vista, arizona",
"sioux city, iowa",
"sioux falls, south dakota",
"south bend, indiana",
"spartanburg, south carolina",
"spokane, washington",
"springfield, illinois",
"springfield, massachusetts",
"springfield, missouri",
"springfield, ohio",
"st. cloud, minnesota",
"st. george, utah",
"st. joseph, missouri",
"st. louis, missouri",
"state college, pennsylvania",
"staunton, virginia",
"stockton, california",
"sumter, south carolina",
"syracuse, new york",
"tallahassee, florida",
"tampa, florida",
"terre haute, indiana",
"texarkana, texas",
"toledo, ohio",
"topeka, kansas",
"trenton, new jersey",
"tucson, arizona",
"tulsa, oklahoma",
"tuscaloosa, alabama",
"twin falls, idaho",
"tyler, texas",
"urban honolulu, hawaii",
"utica, new york",
"valdosta, georgia",
"vallejo, california",
"victoria, texas",
"vineland, new jersey",
"virginia beach, virginia",
"visalia, california",
"waco, texas",
"walla walla, washington",
"warner robins, georgia",
"waterloo, iowa",
"watertown, new york",
"wausau, wisconsin",
"weirton, west virginia",
"wenatchee, washington",
"wheeling, west virginia",
"wichita falls, texas",
"wichita, kansas",
"williamsport, pennsylvania",
"wilmington, north carolina",
"winchester, virginia",
"worcester, massachusetts",
"yakima, washington",
"york, pennsylvania",
"youngstown, ohio",
"yuba city, california",
"yuma, arizona"
],
"description": "A person's current company's HQ metro area"
},
"job_company_location_region": {
"type": "string",
"description": "A person's current company's HQ region"
},
"job_company_location_geo": {
"type": "string",
"description": "A person's current company's HQ geo"
},
"job_company_location_street_address": {
"type": "string",
"description": "A person's current company's HQ street_address"
},
"job_company_location_address_line_2": {
"type": "string",
"description": "A person's current company's HQ address line 2"
},
"job_company_location_postal_code": {
"type": "string",
"description": "A person's current company's HQ postal code"
},
"job_company_location_country": {
"type": "string",
"enum": [
"afghanistan",
"albania",
"algeria",
"american samoa",
"andorra",
"angola",
"anguilla",
"antarctica",
"antigua and barbuda",
"argentina",
"armenia",
"aruba",
"australia",
"austria",
"azerbaijan",
"bahamas",
"bahrain",
"bangladesh",
"barbados",
"belarus",
"belgium",
"belize",
"benin",
"bermuda",
"bhutan",
"bolivia",
"bosnia and herzegovina",
"botswana",
"bouvet island",
"brazil",
"british indian ocean territory",
"british virgin islands",
"brunei",
"bulgaria",
"burkina faso",
"burundi",
"cambodia",
"cameroon",
"canada",
"cape verde",
"caribbean netherlands",
"cayman islands",
"central african republic",
"chad",
"chile",
"china",
"christmas island",
"cocos (keeling) islands",
"colombia",
"comoros",
"cook islands",
"costa rica",
"croatia",
"cuba",
"curaçao",
"cyprus",
"czechia",
"democratic republic of the congo",
"denmark",
"djibouti",
"dominica",
"dominican republic",
"ecuador",
"egypt",
"el salvador",
"equatorial guinea",
"eritrea",
"estonia",
"ethiopia",
"falkland islands",
"faroe islands",
"fiji",
"finland",
"france",
"french guiana",
"french polynesia",
"french southern territories",
"gabon",
"gambia",
"georgia",
"germany",
"ghana",
"gibraltar",
"greece",
"greenland",
"grenada",
"guadeloupe",
"guam",
"guatemala",
"guernsey",
"guinea",
"guinea-bissau",
"guyana",
"haiti",
"heard island and mcdonald islands",
"honduras",
"hong kong",
"hungary",
"iceland",
"india",
"indonesia",
"iran",
"iraq",
"ireland",
"isle of man",
"israel",
"italy",
"ivory coast",
"jamaica",
"japan",
"jersey",
"jordan",
"kazakhstan",
"kenya",
"kiribati",
"kosovo",
"kuwait",
"kyrgyzstan",
"laos",
"latvia",
"lebanon",
"lesotho",
"liberia",
"libya",
"liechtenstein",
"lithuania",
"luxembourg",
"macau",
"macedonia",
"madagascar",
"malawi",
"malaysia",
"maldives",
"mali",
"malta",
"marshall islands",
"martinique",
"mauritania",
"mauritius",
"mayotte",
"mexico",
"micronesia",
"moldova",
"monaco",
"mongolia",
"montenegro",
"montserrat",
"morocco",
"mozambique",
"myanmar",
"namibia",
"nauru",
"nepal",
"netherlands",
"netherlands antilles",
"new caledonia",
"new zealand",
"nicaragua",
"niger",
"nigeria",
"niue",
"norfolk island",
"north korea",
"northern mariana islands",
"norway",
"oman",
"pakistan",
"palau",
"palestine",
"panama",
"papua new guinea",
"paraguay",
"peru",
"philippines",
"pitcairn",
"poland",
"portugal",
"puerto rico",
"qatar",
"republic of the congo",
"romania",
"russia",
"rwanda",
"réunion",
"saint barthélemy",
"saint helena",
"saint kitts and nevis",
"saint lucia",
"saint martin",
"saint pierre and miquelon",
"saint vincent and the grenadines",
"samoa",
"san marino",
"saudi arabia",
"senegal",
"serbia",
"seychelles",
"sierra leone",
"singapore",
"sint maarten",
"slovakia",
"slovenia",
"solomon islands",
"somalia",
"south africa",
"south georgia and the south sandwich islands",
"south korea",
"south sudan",
"spain",
"sri lanka",
"sudan",
"suriname",
"svalbard and jan mayen",
"swaziland",
"sweden",
"switzerland",
"syria",
"são tomé and príncipe",
"taiwan",
"tajikistan",
"tanzania",
"thailand",
"timor-leste",
"togo",
"tokelau",
"tonga",
"trinidad and tobago",
"tunisia",
"turkey",
"turkmenistan",
"turks and caicos islands",
"tuvalu",
"u.s. virgin islands",
"uganda",
"ukraine",
"united arab emirates",
"united kingdom",
"united states",
"united states minor outlying islands",
"uruguay",
"uzbekistan",
"vanuatu",
"vatican city",
"venezuela",
"vietnam",
"wallis and futuna",
"western sahara",
"yemen",
"zambia",
"zimbabwe",
"åland islands"
],
"description": "A person's current company's HQ country"
},
"job_company_location_continent": {
"type": "string",
"enum": [
"africa",
"antarctica",
"asia",
"europe",
"north america",
"oceania",
"south america"
],
"description": "A person's current company's HQ continent"
},
"job_last_updated": {
"type": "string",
"format": "date",
"description": "Indicates the timestamp of the most recent source that agrees with this information"
},
"job_start_date": {
"type": "string",
"format": "date",
"description": "Indicates the start period of the object. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY)"
},
"location_name": {
"type": "string",
"description": "the current canonical location of the person"
},
"location_locality": {
"type": "string",
"description": "the current locality of the person"
},
"location_metro": {
"type": "string",
"enum": [
"abilene, texas",
"akron, ohio",
"albany, georgia",
"albany, new york",
"albany, oregon",
"albuquerque, new mexico",
"alexandria, louisiana",
"allentown, pennsylvania",
"altoona, pennsylvania",
"amarillo, texas",
"ames, iowa",
"anchorage, alaska",
"ann arbor, michigan",
"anniston, alabama",
"appleton, wisconsin",
"asheville, north carolina",
"athens, georgia",
"atlanta, georgia",
"atlantic city, new jersey",
"auburn, alabama",
"augusta, georgia",
"austin, texas",
"bakersfield, california",
"baltimore, maryland",
"bangor, maine",
"barnstable town, massachusetts",
"baton rouge, louisiana",
"battle creek, michigan",
"bay city, michigan",
"beaumont, texas",
"bellingham, washington",
"billings, montana",
"binghamton, new york",
"birmingham, alabama",
"bismarck, north dakota",
"blacksburg, virginia",
"bloomington, illinois",
"bloomington, indiana",
"boise city, idaho",
"boston, massachusetts",
"boulder, colorado",
"bowling green, kentucky",
"bremerton, washington",
"bridgeport, connecticut",
"brownsville, texas",
"buffalo, new york",
"burlington, north carolina",
"burlington, vermont",
"canton, ohio",
"cape coral, florida",
"cape girardeau, missouri",
"carbondale, illinois",
"carson city, nevada",
"casper, wyoming",
"cedar rapids, iowa",
"champaign, illinois",
"charleston, south carolina",
"charleston, west virginia",
"charlotte, north carolina",
"charlottesville, virginia",
"chattanooga, tennessee",
"cheyenne, wyoming",
"chicago, illinois",
"chico, california",
"cincinnati, ohio",
"clarksville, tennessee",
"cleveland, ohio",
"cleveland, tennessee",
"coeur d'alene, idaho",
"college station, texas",
"colorado springs, colorado",
"columbia, missouri",
"columbia, south carolina",
"columbus, georgia",
"columbus, indiana",
"columbus, ohio",
"corpus christi, texas",
"corvallis, oregon",
"crestview, florida",
"cumberland, maryland",
"dallas, texas",
"dalton, georgia",
"danville, illinois",
"davenport, iowa",
"dayton, ohio",
"decatur, alabama",
"decatur, illinois",
"deltona, florida",
"denver, colorado",
"des moines, iowa",
"detroit, michigan",
"district of columbia",
"dothan, alabama",
"dover, delaware",
"dubuque, iowa",
"duluth, minnesota",
"durham, north carolina",
"eau claire, wisconsin",
"el centro, california",
"el paso, texas",
"elizabethtown, kentucky",
"elkhart, indiana",
"elmira, new york",
"enid, oklahoma",
"erie, pennsylvania",
"eugene, oregon",
"evansville, indiana",
"fairbanks, alaska",
"fargo, north dakota",
"farmington, new mexico",
"fayetteville, arkansas",
"fayetteville, north carolina",
"flagstaff, arizona",
"flint, michigan",
"florence, alabama",
"florence, south carolina",
"fond du lac, wisconsin",
"fort collins, colorado",
"fort smith, arkansas",
"fort wayne, indiana",
"fresno, california",
"gadsden, alabama",
"gainesville, florida",
"gainesville, georgia",
"goldsboro, north carolina",
"grand forks, north dakota",
"grand island, nebraska",
"grand junction, colorado",
"grand rapids, michigan",
"grants pass, oregon",
"great falls, montana",
"greeley, colorado",
"green bay, wisconsin",
"greensboro, north carolina",
"greenville, north carolina",
"greenville, south carolina",
"gulfport, mississippi",
"hagerstown, maryland",
"hanford, california",
"harrisburg, pennsylvania",
"harrisonburg, virginia",
"hartford, connecticut",
"hattiesburg, mississippi",
"hickory, north carolina",
"hilton head island, south carolina",
"hinesville, georgia",
"hot springs, arkansas",
"houma, louisiana",
"houston, texas",
"huntington, west virginia",
"huntsville, alabama",
"idaho falls, idaho",
"indianapolis, indiana",
"iowa city, iowa",
"ithaca, new york",
"jackson, michigan",
"jackson, mississippi",
"jackson, tennessee",
"jacksonville, florida",
"jacksonville, north carolina",
"janesville, wisconsin",
"jefferson city, missouri",
"johnson city, tennessee",
"johnstown, pennsylvania",
"jonesboro, arkansas",
"joplin, missouri",
"kahului, hawaii",
"kalamazoo, michigan",
"kankakee, illinois",
"kansas city, missouri",
"kennewick, washington",
"killeen, texas",
"kingsport, tennessee",
"kingston, new york",
"knoxville, tennessee",
"kokomo, indiana",
"la crosse, wisconsin",
"lafayette, indiana",
"lafayette, louisiana",
"lake charles, louisiana",
"lake havasu city, arizona",
"lakeland, florida",
"lancaster, pennsylvania",
"lansing, michigan",
"laredo, texas",
"las cruces, new mexico",
"las vegas, nevada",
"lawrence, kansas",
"lawton, oklahoma",
"lebanon, pennsylvania",
"lewiston, idaho",
"lewiston, maine",
"lexington, kentucky",
"lima, ohio",
"lincoln, nebraska",
"little rock, arkansas",
"logan, utah",
"longview, texas",
"longview, washington",
"los angeles, california",
"louisville, kentucky",
"lubbock, texas",
"lynchburg, virginia",
"macon, georgia",
"madera, california",
"madison, wisconsin",
"manchester, new hampshire",
"manhattan, kansas",
"mankato, minnesota",
"mansfield, ohio",
"mcallen, texas",
"medford, oregon",
"memphis, tennessee",
"merced, california",
"miami, florida",
"michigan city, indiana",
"midland, michigan",
"midland, texas",
"milwaukee, wisconsin",
"minneapolis, minnesota",
"missoula, montana",
"mobile, alabama",
"modesto, california",
"monroe, louisiana",
"monroe, michigan",
"montgomery, alabama",
"morgantown, west virginia",
"morristown, tennessee",
"mount vernon, washington",
"muncie, indiana",
"muskegon, michigan",
"myrtle beach, south carolina",
"napa, california",
"naples, florida",
"nashville, tennessee",
"new bern, north carolina",
"new haven, connecticut",
"new orleans, louisiana",
"new york, new york",
"north port, florida",
"norwich, connecticut",
"ocala, florida",
"odessa, texas",
"ogden, utah",
"oklahoma city, oklahoma",
"olympia, washington",
"omaha, nebraska",
"orlando, florida",
"oshkosh, wisconsin",
"owensboro, kentucky",
"oxnard, california",
"palm bay, florida",
"panama city, florida",
"parkersburg, west virginia",
"pensacola, florida",
"peoria, illinois",
"philadelphia, pennsylvania",
"phoenix, arizona",
"pine bluff, arkansas",
"pittsburgh, pennsylvania",
"pittsfield, massachusetts",
"pocatello, idaho",
"port st. lucie, florida",
"portland, maine",
"portland, oregon",
"poughkeepsie, new york",
"prescott valley, arizona",
"providence, rhode island",
"provo, utah",
"pueblo, colorado",
"punta gorda, florida",
"racine, wisconsin",
"raleigh, north carolina",
"rapid city, south dakota",
"reading, pennsylvania",
"redding, california",
"reno, nevada",
"richmond, virginia",
"riverside, california",
"roanoke, virginia",
"rochester, minnesota",
"rochester, new york",
"rockford, illinois",
"rocky mount, north carolina",
"rome, georgia",
"sacramento, california",
"saginaw, michigan",
"salem, oregon",
"salinas, california",
"salisbury, maryland",
"salt lake city, utah",
"san angelo, texas",
"san antonio, texas",
"san diego, california",
"san francisco, california",
"san jose, california",
"san luis obispo, california",
"santa cruz, california",
"santa fe, new mexico",
"santa maria, california",
"santa rosa, california",
"savannah, georgia",
"scranton, pennsylvania",
"seattle, washington",
"sebastian, florida",
"sheboygan, wisconsin",
"sherman, texas",
"shreveport, louisiana",
"sierra vista, arizona",
"sioux city, iowa",
"sioux falls, south dakota",
"south bend, indiana",
"spartanburg, south carolina",
"spokane, washington",
"springfield, illinois",
"springfield, massachusetts",
"springfield, missouri",
"springfield, ohio",
"st. cloud, minnesota",
"st. george, utah",
"st. joseph, missouri",
"st. louis, missouri",
"state college, pennsylvania",
"staunton, virginia",
"stockton, california",
"sumter, south carolina",
"syracuse, new york",
"tallahassee, florida",
"tampa, florida",
"terre haute, indiana",
"texarkana, texas",
"toledo, ohio",
"topeka, kansas",
"trenton, new jersey",
"tucson, arizona",
"tulsa, oklahoma",
"tuscaloosa, alabama",
"twin falls, idaho",
"tyler, texas",
"urban honolulu, hawaii",
"utica, new york",
"valdosta, georgia",
"vallejo, california",
"victoria, texas",
"vineland, new jersey",
"virginia beach, virginia",
"visalia, california",
"waco, texas",
"walla walla, washington",
"warner robins, georgia",
"waterloo, iowa",
"watertown, new york",
"wausau, wisconsin",
"weirton, west virginia",
"wenatchee, washington",
"wheeling, west virginia",
"wichita falls, texas",
"wichita, kansas",
"williamsport, pennsylvania",
"wilmington, north carolina",
"winchester, virginia",
"worcester, massachusetts",
"yakima, washington",
"york, pennsylvania",
"youngstown, ohio",
"yuba city, california",
"yuma, arizona"
],
"description": "the current MSA of the person"
},
"location_region": {
"type": "string",
"description": "the current region of the person"
},
"location_country": {
"type": "string",
"enum": [
"afghanistan",
"albania",
"algeria",
"american samoa",
"andorra",
"angola",
"anguilla",
"antarctica",
"antigua and barbuda",
"argentina",
"armenia",
"aruba",
"australia",
"austria",
"azerbaijan",
"bahamas",
"bahrain",
"bangladesh",
"barbados",
"belarus",
"belgium",
"belize",
"benin",
"bermuda",
"bhutan",
"bolivia",
"bosnia and herzegovina",
"botswana",
"bouvet island",
"brazil",
"british indian ocean territory",
"british virgin islands",
"brunei",
"bulgaria",
"burkina faso",
"burundi",
"cambodia",
"cameroon",
"canada",
"cape verde",
"caribbean netherlands",
"cayman islands",
"central african republic",
"chad",
"chile",
"china",
"christmas island",
"cocos (keeling) islands",
"colombia",
"comoros",
"cook islands",
"costa rica",
"croatia",
"cuba",
"curaçao",
"cyprus",
"czechia",
"democratic republic of the congo",
"denmark",
"djibouti",
"dominica",
"dominican republic",
"ecuador",
"egypt",
"el salvador",
"equatorial guinea",
"eritrea",
"estonia",
"ethiopia",
"falkland islands",
"faroe islands",
"fiji",
"finland",
"france",
"french guiana",
"french polynesia",
"french southern territories",
"gabon",
"gambia",
"georgia",
"germany",
"ghana",
"gibraltar",
"greece",
"greenland",
"grenada",
"guadeloupe",
"guam",
"guatemala",
"guernsey",
"guinea",
"guinea-bissau",
"guyana",
"haiti",
"heard island and mcdonald islands",
"honduras",
"hong kong",
"hungary",
"iceland",
"india",
"indonesia",
"iran",
"iraq",
"ireland",
"isle of man",
"israel",
"italy",
"ivory coast",
"jamaica",
"japan",
"jersey",
"jordan",
"kazakhstan",
"kenya",
"kiribati",
"kosovo",
"kuwait",
"kyrgyzstan",
"laos",
"latvia",
"lebanon",
"lesotho",
"liberia",
"libya",
"liechtenstein",
"lithuania",
"luxembourg",
"macau",
"macedonia",
"madagascar",
"malawi",
"malaysia",
"maldives",
"mali",
"malta",
"marshall islands",
"martinique",
"mauritania",
"mauritius",
"mayotte",
"mexico",
"micronesia",
"moldova",
"monaco",
"mongolia",
"montenegro",
"montserrat",
"morocco",
"mozambique",
"myanmar",
"namibia",
"nauru",
"nepal",
"netherlands",
"netherlands antilles",
"new caledonia",
"new zealand",
"nicaragua",
"niger",
"nigeria",
"niue",
"norfolk island",
"north korea",
"northern mariana islands",
"norway",
"oman",
"pakistan",
"palau",
"palestine",
"panama",
"papua new guinea",
"paraguay",
"peru",
"philippines",
"pitcairn",
"poland",
"portugal",
"puerto rico",
"qatar",
"republic of the congo",
"romania",
"russia",
"rwanda",
"réunion",
"saint barthélemy",
"saint helena",
"saint kitts and nevis",
"saint lucia",
"saint martin",
"saint pierre and miquelon",
"saint vincent and the grenadines",
"samoa",
"san marino",
"saudi arabia",
"senegal",
"serbia",
"seychelles",
"sierra leone",
"singapore",
"sint maarten",
"slovakia",
"slovenia",
"solomon islands",
"somalia",
"south africa",
"south georgia and the south sandwich islands",
"south korea",
"south sudan",
"spain",
"sri lanka",
"sudan",
"suriname",
"svalbard and jan mayen",
"swaziland",
"sweden",
"switzerland",
"syria",
"são tomé and príncipe",
"taiwan",
"tajikistan",
"tanzania",
"thailand",
"timor-leste",
"togo",
"tokelau",
"tonga",
"trinidad and tobago",
"tunisia",
"turkey",
"turkmenistan",
"turks and caicos islands",
"tuvalu",
"u.s. virgin islands",
"uganda",
"ukraine",
"united arab emirates",
"united kingdom",
"united states",
"united states minor outlying islands",
"uruguay",
"uzbekistan",
"vanuatu",
"vatican city",
"venezuela",
"vietnam",
"wallis and futuna",
"western sahara",
"yemen",
"zambia",
"zimbabwe",
"åland islands"
],
"description": "the current country of the person"
},
"location_continent": {
"type": "string",
"enum": [
"africa",
"antarctica",
"asia",
"europe",
"north america",
"oceania",
"south america"
],
"description": "the current continent of the person"
},
"location_street_address": {
"type": "string",
"description": "the current street address of the person"
},
"location_address_line_2": {
"type": "string",
"description": "the current address line 2 of the person"
},
"location_postal_code": {
"type": "string",
"description": "the current postal code of the person"
},
"location_geo": {
"type": "string",
"description": "the current geo of the person"
},
"location_last_updated": {
"type": "string",
"format": "date",
"description": "Indicates the timestamp of the most recent source that agrees with this information"
},
"phone_numbers": {
"type": "array",
"description": "Phone numbers associated with this person profile in E164 format",
"items": {
"type": "string"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
}
},
"interests": {
"type": "array",
"description": "Interests associated with the profile",
"items": {
"type": "string"
}
},
"skills": {
"type": "array",
"description": "Skills associated with the profile",
"items": {
"type": "string"
}
},
"location_names": {
"type": "array",
"description": "list of all canonical location names associated with the person",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"description": "List of regions associated with the person",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"description": "list of countries associated with a person",
"items": {
"type": "string"
}
},
"operation_id": {
"type": "string",
"description": "Currently only in data license deliveries. Allows PDL employees to identify the timestamp and operations performed on the internal data to return a record in a delivery."
},
"version_status": {
"description": "Allows customers track the pervious and current dataset version, any other persistent IDs that were merged into this record using improved entity resolution, and the status of the record",
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
]
}
}
},
"Search": {
"type": "object",
"required": [
"search"
],
"properties": {
"search": {
"type": "string",
"description": "A valid Elasticsearch Query that conforms to the People Data Labs Person Search API"
}
}
},
"SearchV2": {
"type": "object",
"required": [
"search",
"search_name"
],
"properties": {
"search": {
"type": "string",
"description": "A valid lucene boolean query"
},
"search_name": {
"type": "string",
"description": "A 2-4 word phrase to describe the search"
}
}
},
"SearchResponse": {
"type": "object",
"required": [
"id",
"message",
"url",
"count"
],
"properties": {
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"url": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int32"
}
}
},
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
}
}
}