{ "info": { "description": "People Data Labs API", "title": "api.peopledatalabs.com", "version": "5.0" }, "servers": [ { "url": "https://api.peopledatalabs.com" }, { "url": "http://api.peopledatalabs.com" } ], "components": { "securitySchemes": { "APIKeyHeader": { "in": "header", "name": "X-API-Key", "type": "apiKey" } }, "schemas": { "Email": { "type": "object", "properties": { "address": { "type": "string", "description": "The full parsed email" }, "type": { "type": "string", "description": "The type of email either current_professional, professional, personal or null" } }, "required": [ "type" ], "additionalProperties": false }, "StreetAddress": { "type": "object", "properties": { "street_address": { "type": "string", "description": "The street address associated with the location object" }, "address_line_2": { "type": "string", "description": "The secondary street address associated with the location object" }, "name": { "type": "string", "description": "A string that appends location fields together to create a standard location field" }, "locality": { "type": "string", "description": "The administrative locality associated with the location object" }, "metro": { "type": "string", "description": "The metro area associated with the location object" }, "region": { "type": "string", "description": "The administrative region associated with the location object" }, "postal_code": { "type": "string", "description": "The postal code associated with the location object" }, "country": { "type": "string", "description": "The country associated with the location object" }, "geo": { "type": "string", "description": "The geolocation associated with the location object in latitude, longitude format" }, "continent": { "type": "string", "description": "The continent associated with the country in the location object" } }, "additionalProperties": false }, "Title": { "type": "object", "properties": { "name": { "type": "string", "description": "The inputted title from our data sources with some basic cleaning and mapping in order to help with merging" }, "levels": { "type": "array", "enum": [ "unpaid", "training", "entry", "manager", "senior", "partner", "director", "vp", "owner", "cxo" ], "description": "Levels associated with a title", "items": { "type": "string" } }, "role": { "type": "string", "description": "A person's job title derived role" }, "sub_role": { "type": "string", "description": "A person's job title derived subrole. Each subrole maps to a role" } }, "additionalProperties": false }, "ExperienceCompanyLocation": { "type": "object", "properties": { "street_address": { "type": "string", "description": "Company HQ address" }, "address_line_2": { "type": "string", "description": "The address line 2 associated with the company HQ" }, "name": { "type": "string", "description": "The canonical location name associated with the company HQ" }, "locality": { "type": "string", "description": "Company locality" }, "metro": { "type": "string", "description": "Company metro area" }, "region": { "type": "string", "description": "Company region" }, "country": { "type": "string", "description": "Company country" }, "postal_code": { "type": "string", "description": "The postal code associated with the company" }, "continent": { "type": "string", "description": "The continent associated with the company HQ" }, "geo": { "type": "string", "description": "The geo code associated with the company HQ" } }, "additionalProperties": false }, "ExperienceCompany": { "type": "object", "properties": { "id": { "type": "string", "description": "Our current NOT PERSISTENT ids that tie company data to the canonical data" }, "name": { "type": "string", "description": "The name associated with the company" }, "website": { "type": "string", "description": "The website associated with the company" }, "founded": { "type": "string", "format": "date", "description": "The year that the company was founded" }, "size": { "type": "string", "description": "The size range of the company" }, "industry": { "type": "string", "description": "The industry associated with the company" }, "linkedin_url": { "type": "string", "description": "The linkedin url associated with the company" }, "linkedin_id": { "type": "string", "description": "The linkedin id associated with the company" }, "facebook_url": { "type": "string", "description": "The facebook url associated with the company" }, "twitter_url": { "type": "string", "description": "The twitter associated with the company" }, "location": { "$ref": "#/components/schemas/ExperienceCompanyLocation" } }, "additionalProperties": false }, "Experience": { "type": "object", "properties": { "title": { "description": "A dictionary object that provides a raw title, canonized title, and level", "allOf": [ { "$ref": "#/components/schemas/Title" } ] }, "company": { "description": "A dictionary of information for the associated company", "allOf": [ { "$ref": "#/components/schemas/ExperienceCompany" } ] }, "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)" }, "end_date": { "type": "string", "format": "date", "description": "Indicates the end period of the object" }, "location_names": { "type": "string", "description": "Canonical locations associated with this particular job/experience object (where the person is working, which may or may not be where the company is headquartered.)" }, "is_primary": { "type": "boolean", "description": "Indicates if the experience is the primary experience object in our dataset. This experience object will exist in the job_XXX fields" } }, "additionalProperties": false }, "SchoolLocation": { "type": "object", "properties": { "name": { "type": "string", "description": "The canonical name of the location associated with the school" }, "locality": { "type": "string", "description": "The locality associated with the school" }, "region": { "type": "string", "description": "The region associated with the school" }, "country": { "type": "string", "description": "The country associated with the school" }, "continent": { "type": "string", "description": "The continent associated with the school" } }, "additionalProperties": false }, "School": { "type": "object", "properties": { "id": { "type": "string", "description": "Our current NOT PERSISTENT ids that tie company data to the canonical data" }, "name": { "type": "string", "description": "The name associated with the school" }, "website": { "type": "string", "description": "The website associated with the school, could include subdomains" }, "domain": { "type": "string", "description": "The website associated with the school" }, "type": { "type": "string", "description": "The type of school" }, "linkedin_url": { "type": "string", "description": "The linkedin url associated with the school" }, "linkedin_id": { "type": "string", "description": "The linkedin ID associated with the school" }, "facebook_url": { "type": "string", "description": "The facebook url associated with the school" }, "twitter_url": { "type": "string", "description": "The twitter url associated with the school" }, "location": { "description": "The location associated with the school", "allOf": [ { "$ref": "#/components/schemas/SchoolLocation" } ] } }, "additionalProperties": false }, "Education": { "type": "object", "properties": { "degrees": { "type": "array", "enum": [ "associate of arts", "bachelor of aerospace engineering", "bachelor of applied science", "bachelor of architecture", "bachelor of arts", "bachelor of arts in business administration", "bachelor of arts in communication", "bachelor of arts in education", "bachelor of biosystems engineering", "bachelor of business administration", "bachelor of chemical engineering", "bachelor of civil engineering", "bachelor of commerce", "bachelor of design", "bachelor of education", "bachelor of electrical engineering", "bachelor of engineering", "bachelor of fine arts", "bachelor of general studies", "bachelor of industrial & systems engineering", "bachelor of industrial design", "bachelor of interdisciplinary studies", "bachelor of interior architecture", "bachelor of law", "bachelor of liberal arts", "bachelor of liberal arts and sciences", "bachelor of materials engineering", "bachelor of mathematics", "bachelor of mechanical engineering", "bachelor of medicine", "bachelor of music", "bachelor of music education", "bachelor of pharmacy", "bachelor of polymer and fiber engineering", "bachelor of professional health science", "bachelor of science", "bachelor of science in aerospace engineering", "bachelor of science in biomedical engineering", "bachelor of science in business administration", "bachelor of science in chemical engineering", "bachelor of science in chemistry", "bachelor of science in civil engineering", "bachelor of science in commerce business administration", "bachelor of science in computer science", "bachelor of science in education", "bachelor of science in electrical engineering", "bachelor of science in engineering", "bachelor of science in engineering technology", "bachelor of science in geology", "bachelor of science in human environmental sciences", "bachelor of science in materials engineering", "bachelor of science in mechanical engineering", "bachelor of science in metallurgical engineering", "bachelor of science in microbiology", "bachelor of science in nursing", "bachelor of science in social work", "bachelor of social work", "bachelor of software engineering", "bachelor of technology", "bachelor of textile engineering", "bachelor of textile management and technology", "bachelor of veterinary science", "bachelor of wireless engineering", "doctor of audiology", "doctor of business administration", "doctor of chiropractic", "doctor of dental surgery", "doctor of education", "doctor of jurisprudence", "doctor of medical dentistry", "doctor of medicine", "doctor of ministry", "doctor of musical arts", "doctor of nursing practice", "doctor of optometry", "doctor of osteophathy", "doctor of pharmacy", "doctor of philosophy", "doctor of physical therapy", "doctor of psychology", "doctor of public health", "doctor of science", "doctor of veterinary medicine", "magister juris", "master of accountancy", "master of accounting", "master of aerospace engineering", "master of agriculture", "master of applied mathematics", "master of aquaculture", "master of arts", "master of arts in education", "master of arts in teaching", "master of building construction", "master of business administration", "master of chemical engineering", "master of civil engineering", "master of commerce", "master of communication disorders", "master of community planning", "master of dental surgery", "master of design", "master of divinity", "master of education", "master of electrical engineering", "master of engineering", "master of fine arts", "master of health science", "master of hispanic studies", "master of industrial design", "master of integrated design and construction", "master of international studies", "master of landscape architecture", "master of laws", "master of liberal arts", "master of library & information studies", "master of library science", "master of materials engineering", "master of mechanical engineering", "master of music", "master of natural resources", "master of nurse anesthesia", "master of political science", "master of probability and statistics", "master of professional studies", "master of public administration", "master of public health", "master of real estate development", "master of rehabilitation counseling", "master of science", "master of science in aerospace engineering", "master of science in basic medical sciences", "master of science in biomedical engineering", "master of science in chemical engineering", "master of science in chemistry", "master of science in civil engineering", "master of science in computer science", "master of science in criminal justice", "master of science in education", "master of science in electrical engineering", "master of science in engineering science & mechanics", "master of science in forensic science", "master of science in health administration", "master of science in health informatics", "master of science in human environmental sciences", "master of science in industrial engineering", "master of science in information systems", "master of science in instructional leadership administration", "master of science in justice and public safety", "master of science in marine science", "master of science in materials engineering", "master of science in mechanical engineering", "master of science in metallurgical engineering", "master of science in nursing", "master of science in occupational therapy", "master of science in operations research", "master of science in physician assistant studies", "master of science in public health", "master of science in software engineering", "master of social work", "master of software engineering", "master of tax accounting", "master of taxation", "master of technical & professional communication", "master of technology", "master of urban and regional planning" ], "description": "A list of canonical degrees associated with this education object", "items": { "type": "string" } }, "majors": { "type": "array", "enum": [ "3d modelling", "3d modelling and animation", "accountancy", "accounting", "acting", "actuarial science", "addiction counseling", "administration of justice", "advertising", "aerospace and aeronautical engineering", "aerospace engineering", "african american studies", "african culture", "african language", "african language and culture", "african language and literature", "african language studies", "african languages", "african literature", "african literature and culture", "african studies", "africana studies", "africana study", "afrikaans", "afrikaans culture", "afrikaans language", "afrikaans language and culture", "afrikaans language and literature", "afrikaans language studies", "afrikaans languages", "afrikaans literature", "afrikaans literature and culture", "afrikaans studies", "agricultural economics", "agricultural engineering", "agriculture", "agriculture production and management", "agronomy", "airway science", "american history", "american indian studies", "american literature", "american sign language", "american studies", "anatomy", "ancient civilizations", "anesthesiology", "animal behavior", "animal bioscience", "animal science", "animation", "anthropology", "anthropology and archeology", "apparel and merchandising", "apparel and textiles", "apparel design", "applied digital art", "applied economics", "applied graphic design", "applied linguistics", "applied mathematics", "applied physics", "applied psychology", "applied science", "applied statistics", "aquaculture", "aquatics", "arabic", "arabic culture", "arabic language", "arabic language and culture", "arabic language and literature", "arabic language studies", "arabic languages", "arabic literature", "arabic literature and culture", "arabic studies", "archeology", "architectural engineering", "architectural tech", "architecture", "architecture and engineering", "area ethnic and civilization studies", "art", "art and design", "art and music education", "art education", "art history", "art therapy", "asian american studies", "asian studies", "astrology", "astronomy", "astronomy and astrophysics", "astrophysics", "atmospheric science and meteorology", "audiology", "automotive mechanics", "aviation", "avionic systems", "avionics", "avionics maintenance", "baking", "baking and pastry art", "balkan culture", "balkan language", "balkan language and culture", "balkan language and literature", "balkan language studies", "balkan languages", "balkan literature", "balkan literature and culture", "balkan studies", "ballet", "baltic culture", "baltic language", "baltic language and culture", "baltic language and literature", "baltic language studies", "baltic languages", "baltic literature", "baltic literature and culture", "baltic studies", "banking", "behavioral science", "behavioural science", "biblical preaching", "biblical studies", "biobehavioral health", "biochemical engineering", "biochemical science", "biochemistry", "bioengineering", "bioinformatics", "biological engineering", "biological science", "biology", "biomedical engineering", "biomedical science", "biophysics", "biotechnology", "botany", "brass instruments", "british literature", "broadcast and cinematic art", "broadcast journalism", "broadcasting", "buddhist studies", "bulgarian", "bulgarian culture", "bulgarian language", "bulgarian language and culture", "bulgarian language and literature", "bulgarian language studies", "bulgarian languages", "bulgarian literature", "bulgarian literature and culture", "bulgarian studies", "business", "business admin", "business administration", "business administration and management", "business and medical administration", "business economics", "business finance", "business law", "business management", "business management and administration", "business marketing", "business studies", "celtic studies", "ceramics", "chemical engineering", "chemistry", "chicano", "chicano culture", "chicano studies", "child and adolescent development", "child development", "chinese", "chinese culture", "chinese language", "chinese language and culture", "chinese language and literature", "chinese language studies", "chinese languages", "chinese literature", "chinese literature and culture", "chinese studies", "choral conducting", "choral maintenance tech", "christian administration", "christian doctorine", "christian preaching", "civil engineering", "classical culture", "classical language", "classical language and culture", "classical language and literature", "classical language studies", "classical languages", "classical literature", "classical literature and culture", "classical studies", "classics", "clinical nurse", "clinical nursing", "clinical psychology", "coaching", "cognitive science", "cognitive science and biopsychology", "college student affairs", "commerce", "commercial art", "commercial science", "commercial studies", "communication", "communication art", "communication disorders science and services", "communication management", "communication studies", "communication tech", "communications", "communications and media studies", "community and public health", "community development", "comp lit", "comp sci", "comparative literature", "comparative race and ethnic studies", "comparative religious studies", "composition", "composition and rhetoric", "computer administration management and security", "computer and information science", "computer and information systems", "computer application", "computer applications", "computer engineering", "computer graphics", "computer information systems", "computer networking and telecommunications", "computer programming", "computer programming and data processing", "computer science", "computer science and electrical engineering", "computer science and engineering", "computer science and mathematics", "computer systems", "computer systems engineering", "computer systems management", "computer tech", "conducting", "conflict resolution", "construction", "construction and land development", "construction management", "construction services", "consulting", "consulting and sales", "consumer science", "corporate finance", "corporate law", "corrections", "cosmetology", "cosmetology services and culinary art", "counseling", "counseling psychology", "court reporting", "creative writing", "criminal justice", "criminal justice and fire protection", "criminology", "culinary art", "culinary arts", "curriculum and instruction", "curriculum supervision", "customer service", "customer service management", "cybersecurity", "czech", "czech culture", "czech language", "czech language and culture", "czech language and literature", "czech language studies", "czech languages", "czech literature", "czech literature and culture", "czech studies", "dance", "dance performance", "danish", "danish culture", "danish language", "danish language and culture", "danish language and literature", "danish language studies", "danish languages", "danish literature", "danish literature and culture", "danish studies", "data science", "demography", "dental hygiene", "dental tech", "dentistry", "design", "digital art", "digital video", "digital video and cinema", "digital visual effects", "disability studies", "distribution management", "diversity studies", "divinity", "documentary production", "drama", "drama and theater art", "drawing", "drug development", "dutch", "dutch culture", "dutch language", "dutch language and culture", "dutch language and literature", "dutch language studies", "dutch languages", "dutch literature", "dutch literature and culture", "dutch studies", "early childhood education", "earth science", "east asian studies", "ecology", "economics", "education", "educational administration and supervision", "educational psychology", "electrical engineering", "electrical engineering and computer science", "electrical engineering tech", "electronics", "electronics engineering", "elementary education", "energy", "energy and climate policy", "energy and enviornmental analysis", "engineering", "engineering and industrial management", "engineering mechanics physics and science", "engineering tech", "english", "english as a second language", "english culture", "english language", "english language and culture", "english language and literature", "english language arts", "english language studies", "english languages", "english literature", "english literature and culture", "english studies", "entomology", "entrepreneurial studies", "entrepreneurship", "environmental and geotechnical engineering", "environmental engineering", "environmental science", "environmental studies", "epidemiology", "ethics", "european civilization", "european history", "european modern languages", "european studies", "event planning", "exercise and sport science", "exercise science", "family and community services", "family and consumer science", "family science", "family therapy", "fashion", "fashion design", "feminine spirituality", "feminine studies", "film", "film and television", "film directing", "film photography and visual art", "film video and photographic art", "finance", "finance and marketing", "financial accounting", "financial economics", "financial engineering", "financial forensics", "financial forensics and fraud investigation", "financial management", "fine and studio art", "fine art", "fine arts", "finnish", "finnish culture", "finnish language", "finnish language and culture", "finnish language and literature", "finnish language studies", "finnish languages", "finnish literature", "finnish literature and culture", "finnish studies", "fisheries and wildlife science", "flute", "flute performance", "folklore", "folklore studies", "food and nutritional science", "food preparation", "food safety", "food science", "foreign relations", "foreign studies", "forensic chemistry", "forensic computing", "forensic science", "forensics", "forest science", "forest tech", "forestry", "francophone studies", "french", "french culture", "french language", "french language and culture", "french language and literature", "french language studies", "french languages", "french literature", "french literature and culture", "french pastry", "french studies", "fundraising", "fundraising and grantmaking", "game design", "gay and lesbian studies", "gay lesbian studies", "gender and diversity studies", "gender and womens studies", "gender studies", "general agriculture", "general business", "general education", "general engineering", "general medical and health services", "general science", "general social science", "general studies", "genetics", "genomics", "geochemistry", "geography", "geological and geophysical engineering", "geology", "geology and earth science", "geophysics", "geoscience", "geosciences", "geotechnical engineering", "german", "german culture", "german language", "german language and culture", "german language and literature", "german language studies", "german languages", "german literature", "german literature and culture", "german studies", "global health", "global history", "global studies", "government", "government and management", "government and politics", "graphic and printing", "graphic and printing science", "graphic art", "graphic design", "greek", "greek culture", "greek language", "greek language and culture", "greek language and literature", "greek language studies", "greek languages", "greek literature", "greek literature and culture", "greek mythology", "greek studies", "gynecology", "health administration", "health and medical administrative services", "health and medical preparatory programs", "health care", "health care administration", "health education", "health medical professions", "health promotion", "health science", "health service administration", "health services", "healthcare", "healthcare administration", "hebrew", "hebrew culture", "hebrew language", "hebrew language and culture", "hebrew language and literature", "hebrew language studies", "hebrew languages", "hebrew literature", "hebrew literature and culture", "hebrew studies", "hindi", "hindi culture", "hindi language", "hindi language and culture", "hindi language and literature", "hindi language studies", "hindi languages", "hindi literature", "hindi literature and culture", "hindi studies", "hindu", "hindu studies", "historic preservation", "history", "holocaust studies", "homeland security", "horticulture", "hospitality", "hospitality and tourism", "hospitality management", "hotel management", "human development", "human physiology", "human relations", "human resource development", "human resource management", "human resources", "human resources and personnel management", "human resources management", "human services", "human services and community organization", "humanities", "hungarian", "hungarian culture", "hungarian language", "hungarian language and culture", "hungarian language and literature", "hungarian language studies", "hungarian languages", "hungarian literature", "hungarian literature and culture", "hungarian studies", "illustration", "illustraton", "immunology", "indonesian", "indonesian and malay languages", "indonesian culture", "indonesian language", "indonesian language and culture", "indonesian language and literature", "indonesian language studies", "indonesian languages", "indonesian literature", "indonesian literature and culture", "indonesian studies", "industrial administration", "industrial and manufacturing engineering", "industrial and organizational psychology", "industrial design", "industrial engineering", "industrial engineering and operations research", "industrial production tech", "industrial relations", "industrial safety", "industrial sales", "industrial tech", "informatics", "information science", "information science and agronomy", "information science and tech", "information systems", "information systems management", "information tech", "instructional tech", "interactive media", "intercultural and international studies", "interdisciplinary social science", "interdisciplinary studies", "international affairs", "international business", "international commerce", "international communications", "international development", "international development and conflict management", "international economic relations", "international economics", "international finance", "international law", "international relations", "international studies", "investment analysis", "investment banking", "irish studies", "islamic culture", "islamic religion", "islamic studies", "italian", "italian culture", "italian language", "italian language and culture", "italian language and literature", "italian language studies", "italian languages", "italian literature", "italian literature and culture", "italian studies", "japanese", "japanese culture", "japanese language", "japanese language and culture", "japanese language and literature", "japanese language studies", "japanese languages", "japanese literature", "japanese literature and culture", "japanese studies", "jazz", "jazz performance", "journalism", "judaic studies", "kinesiology", "korean", "korean culture", "korean language", "korean language and culture", "korean language and literature", "korean language studies", "korean languages", "korean literature", "korean literature and culture", "korean studies", "labor relations", "labor studies", "landscape architecture", "landscaping", "landscaping and groundskeeping", "language and drama education", "latin", "latin american and caribbean studies", "latin american studies", "law", "law enforcement", "law enforcement executive development", "leadership", "legal administration", "legal studies", "lgbtq studies", "liberal art", "liberal arts", "liberal studies", "library science", "linguistics", "linguistics and comparative language and literature", "literature", "liturgical studies", "logic", "logistics", "management", "management information systems and statistics", "management science", "management studies", "mandarin", "mandarin chinese", "mandarin culture", "mandarin language", "mandarin language and culture", "mandarin language and literature", "mandarin language studies", "mandarin languages", "mandarin literature", "mandarin literature and culture", "mandarin studies", "marine biology", "marine science", "marketing", "masonry", "mass media", "materials engineering and materials science", "materials science", "mathematical modeling", "mathematical science", "mathematics", "mechanical engineering", "mechanical engineering related tech", "mechanical tech", "mechatronics", "mechatronics and automation", "mechatronics engineering", "media art", "media art and entertainment", "media management", "media studies", "medical assisting services", "medical biology", "medical engineering", "medical insurance", "medical tech", "medicine", "medieval and renaissance studies", "medieval studies", "metallurgical engineering", "metaphysics", "meteorology", "microbiology", "middle eastern studies", "military science", "military tech", "mining", "mining and mineral engineering", "mining engineering", "ministry", "modern art", "modern languages", "molecular biology", "molecular biophysics", "multicultural studies", "multimedia", "multimedia journalism", "music", "music education", "mythology", "mythology and folklore", "nanotechnology", "native american studies", "natural resource conservation", "natural resources conservation", "natural resources management", "natural science", "naval architecture", "naval architecture and marine engineering", "naval architecture and ocean engineering", "near and middle eastern studies", "near eastern studies", "network administration", "network and systems administration", "neuroscience", "norwegian", "norwegian culture", "norwegian language", "norwegian language and culture", "norwegian language and literature", "norwegian language studies", "norwegian languages", "norwegian literature", "norwegian literature and culture", "norwegian studies", "nuclear engineering", "nuclear propulsion", "number theory", "nursing", "nursing administration", "nutrition", "nutrition science", "nutritional science", "occupational health", "occupational health and safety", "occupational safety", "occupational safety engineering", "occupational therapy", "oceanography", "operations logistics", "operations logistics and e-commerce", "operations management", "optometry", "orchestral conducting", "organ performance", "organic chemistry", "organization administration", "organizational and professional communications", "organizational communications", "organizational leadership", "organizational management", "orthodontics", "painting", "paleontology", "paralegal", "paralegal studies", "parks and recreation", "parks recreation and leisure studies", "percussion", "performing art", "performing arts", "petroleum engineering", "petroleum geoscience", "petroleum tech", "pharmaceutical administration", "pharmaceutical development", "pharmaceutical science", "pharmacology", "pharmacy", "philosophy", "photography", "physical activity", "physical and health education teaching", "physical education", "physical fitness parks recreation and leisure", "physical science", "physical therapy", "physics", "physiology", "physiotherapy", "piano", "piano performace", "piano performance", "planetary and atmospheric science", "plant science", "plant science and agronomy", "playwriting", "poetry", "police science", "political development", "political science", "political science and government", "politics", "poly sci", "portuguese", "portuguese culture", "portuguese language", "portuguese language and culture", "portuguese language and literature", "portuguese language studies", "portuguese languages", "portuguese literature", "portuguese literature and culture", "portuguese studies", "pre dental", "pre law", "pre law and legal studies", "pre med", "pre optometry", "pre orthodontics", "prelaw", "premed", "premedicine", "product design", "product marketing", "production tech", "project management", "psychology", "public admin", "public administration", "public affairs", "public health", "public law", "public policy", "public relations", "public service", "public service and administration", "publishing", "puppetry", "quality improvement", "queer studies", "rabbinic studies", "rabbinical studies", "radio broadcasting", "radiology", "real estate", "recording art", "recording arts", "recreation administration", "regional planning", "religious education", "religious studies", "retail", "rhetoric", "robotics", "russian", "russian culture", "russian language", "russian language and culture", "russian language and literature", "russian language studies", "russian languages", "russian literature", "russian literature and culture", "russian studies", "scandinavian", "scandinavian culture", "scandinavian language", "scandinavian language and culture", "scandinavian language and literature", "scandinavian language studies", "scandinavian languages", "scandinavian literature", "scandinavian literature and culture", "scandinavian studies", "school student counseling", "science and computer teacher education", "science information", "science tech", "science tech and society", "screen art and cultures", "screen writing", "screenwriting", "sculpture", "secondary teacher education", "semiconductor manufacturing", "serbian", "serbian culture", "serbian language", "serbian language and culture", "serbian language and literature", "serbian language studies", "serbian languages", "serbian literature", "serbian literature and culture", "serbian studies", "slavic culture", "slavic language", "slavic language and culture", "slavic language and literature", "slavic language studies", "slavic languages", "slavic literature", "slavic literature and culture", "slavic studies", "social psychology", "social science", "social sciences", "social services", "social studies", "social work", "sociology", "software development", "software engineering", "soil science", "sommelier", "spanish", "spanish culture", "spanish language", "spanish language and culture", "spanish language and literature", "spanish language studies", "spanish languages", "spanish literature", "spanish literature and culture", "spanish studies", "special education", "special needs education", "speech and hearing science", "speech communications", "speech language pathology", "speech pathology", "speech science", "sport administration", "sport communications", "sport management", "sport philosophy", "sport psychology", "sports and fitness", "sports management", "statistics", "statistics and decision science", "stringed instruments", "studio art", "studio arts", "supply chain management", "sustainability", "sustainability management", "sustainability studies", "swedish", "swedish culture", "swedish language", "swedish language and culture", "swedish language and literature", "swedish language studies", "swedish languages", "swedish literature", "swedish literature and culture", "swedish studies", "talmudic studies", "taxidermy", "teacher education", "teaching", "telecom and electronics", "telecommunications", "television", "television broadcasting", "theater", "theater art", "theater arts", "theatre", "theological studies", "theology", "theology and religious vocations", "tibetan", "tibetan culture", "tibetan language", "tibetan language and culture", "tibetan language and literature", "tibetan language studies", "tibetan languages", "tibetan literature", "tibetan literature and culture", "tibetan studies", "tourism", "tourism management", "toxicology", "transportation science and tech", "travel and tourism management", "travel services management", "treatment therapy professions", "trial advocacy", "turfgrass science", "turkish", "turkish culture", "turkish language", "turkish language and culture", "turkish language and literature", "turkish language studies", "turkish languages", "turkish literature", "turkish literature and culture", "turkish studies", "ukrainian", "ukrainian culture", "ukrainian language", "ukrainian language and culture", "ukrainian language and literature", "ukrainian language studies", "ukrainian languages", "ukrainian literature", "ukrainian literature and culture", "ukrainian studies", "united states history", "urban planning", "urban schooling", "urban social studies", "urban sociology", "urban studies", "veterinary pathology", "veterinary science", "veterinary studies", "vietnamese", "vietnamese culture", "vietnamese language", "vietnamese language and culture", "vietnamese language and literature", "vietnamese language studies", "vietnamese languages", "vietnamese literature", "vietnamese literature and culture", "vietnamese studies", "virology", "visual and performing art", "visual art", "visual communications", "visual effects", "viticulture", "vlsi design", "vlsi engineer", "vocal performance", "vocational counseling", "vocational rehabilitation", "voice", "voice and opera", "web development", "welding", "welding engineering", "wellness management", "wildlife and fisheries science", "wildlife and fishery science", "wildlife science", "wildlife tech", "womens studies", "writing", "writing and culture", "zoology" ], "description": "A list of majors associated with this education object", "items": { "type": "string" } }, "minors": { "type": "array", "enum": [ "3d modelling", "3d modelling and animation", "accountancy", "accounting", "acting", "actuarial science", "addiction counseling", "administration of justice", "advertising", "aerospace and aeronautical engineering", "aerospace engineering", "african american studies", "african culture", "african language", "african language and culture", "african language and literature", "african language studies", "african languages", "african literature", "african literature and culture", "african studies", "africana studies", "africana study", "afrikaans", "afrikaans culture", "afrikaans language", "afrikaans language and culture", "afrikaans language and literature", "afrikaans language studies", "afrikaans languages", "afrikaans literature", "afrikaans literature and culture", "afrikaans studies", "agricultural economics", "agricultural engineering", "agriculture", "agriculture production and management", "agronomy", "airway science", "american history", "american indian studies", "american literature", "american sign language", "american studies", "anatomy", "ancient civilizations", "anesthesiology", "animal behavior", "animal bioscience", "animal science", "animation", "anthropology", "anthropology and archeology", "apparel and merchandising", "apparel and textiles", "apparel design", "applied digital art", "applied economics", "applied graphic design", "applied linguistics", "applied mathematics", "applied physics", "applied psychology", "applied science", "applied statistics", "aquaculture", "aquatics", "arabic", "arabic culture", "arabic language", "arabic language and culture", "arabic language and literature", "arabic language studies", "arabic languages", "arabic literature", "arabic literature and culture", "arabic studies", "archeology", "architectural engineering", "architectural tech", "architecture", "architecture and engineering", "area ethnic and civilization studies", "art", "art and design", "art and music education", "art education", "art history", "art therapy", "asian american studies", "asian studies", "astrology", "astronomy", "astronomy and astrophysics", "astrophysics", "atmospheric science and meteorology", "audiology", "automotive mechanics", "aviation", "avionic systems", "avionics", "avionics maintenance", "baking", "baking and pastry art", "balkan culture", "balkan language", "balkan language and culture", "balkan language and literature", "balkan language studies", "balkan languages", "balkan literature", "balkan literature and culture", "balkan studies", "ballet", "baltic culture", "baltic language", "baltic language and culture", "baltic language and literature", "baltic language studies", "baltic languages", "baltic literature", "baltic literature and culture", "baltic studies", "banking", "behavioral science", "behavioural science", "biblical preaching", "biblical studies", "biobehavioral health", "biochemical engineering", "biochemical science", "biochemistry", "bioengineering", "bioinformatics", "biological engineering", "biological science", "biology", "biomedical engineering", "biomedical science", "biophysics", "biotechnology", "botany", "brass instruments", "british literature", "broadcast and cinematic art", "broadcast journalism", "broadcasting", "buddhist studies", "bulgarian", "bulgarian culture", "bulgarian language", "bulgarian language and culture", "bulgarian language and literature", "bulgarian language studies", "bulgarian languages", "bulgarian literature", "bulgarian literature and culture", "bulgarian studies", "business", "business admin", "business administration", "business administration and management", "business and medical administration", "business economics", "business finance", "business law", "business management", "business management and administration", "business marketing", "business studies", "celtic studies", "ceramics", "chemical engineering", "chemistry", "chicano", "chicano culture", "chicano studies", "child and adolescent development", "child development", "chinese", "chinese culture", "chinese language", "chinese language and culture", "chinese language and literature", "chinese language studies", "chinese languages", "chinese literature", "chinese literature and culture", "chinese studies", "choral conducting", "choral maintenance tech", "christian administration", "christian doctorine", "christian preaching", "civil engineering", "classical culture", "classical language", "classical language and culture", "classical language and literature", "classical language studies", "classical languages", "classical literature", "classical literature and culture", "classical studies", "classics", "clinical nurse", "clinical nursing", "clinical psychology", "coaching", "cognitive science", "cognitive science and biopsychology", "college student affairs", "commerce", "commercial art", "commercial science", "commercial studies", "communication", "communication art", "communication disorders science and services", "communication management", "communication studies", "communication tech", "communications", "communications and media studies", "community and public health", "community development", "comp lit", "comp sci", "comparative literature", "comparative race and ethnic studies", "comparative religious studies", "composition", "composition and rhetoric", "computer administration management and security", "computer and information science", "computer and information systems", "computer application", "computer applications", "computer engineering", "computer graphics", "computer information systems", "computer networking and telecommunications", "computer programming", "computer programming and data processing", "computer science", "computer science and electrical engineering", "computer science and engineering", "computer science and mathematics", "computer systems", "computer systems engineering", "computer systems management", "computer tech", "conducting", "conflict resolution", "construction", "construction and land development", "construction management", "construction services", "consulting", "consulting and sales", "consumer science", "corporate finance", "corporate law", "corrections", "cosmetology", "cosmetology services and culinary art", "counseling", "counseling psychology", "court reporting", "creative writing", "criminal justice", "criminal justice and fire protection", "criminology", "culinary art", "culinary arts", "curriculum and instruction", "curriculum supervision", "customer service", "customer service management", "cybersecurity", "czech", "czech culture", "czech language", "czech language and culture", "czech language and literature", "czech language studies", "czech languages", "czech literature", "czech literature and culture", "czech studies", "dance", "dance performance", "danish", "danish culture", "danish language", "danish language and culture", "danish language and literature", "danish language studies", "danish languages", "danish literature", "danish literature and culture", "danish studies", "data science", "demography", "dental hygiene", "dental tech", "dentistry", "design", "digital art", "digital video", "digital video and cinema", "digital visual effects", "disability studies", "distribution management", "diversity studies", "divinity", "documentary production", "drama", "drama and theater art", "drawing", "drug development", "dutch", "dutch culture", "dutch language", "dutch language and culture", "dutch language and literature", "dutch language studies", "dutch languages", "dutch literature", "dutch literature and culture", "dutch studies", "early childhood education", "earth science", "east asian studies", "ecology", "economics", "education", "educational administration and supervision", "educational psychology", "electrical engineering", "electrical engineering and computer science", "electrical engineering tech", "electronics", "electronics engineering", "elementary education", "energy", "energy and climate policy", "energy and enviornmental analysis", "engineering", "engineering and industrial management", "engineering mechanics physics and science", "engineering tech", "english", "english as a second language", "english culture", "english language", "english language and culture", "english language and literature", "english language arts", "english language studies", "english languages", "english literature", "english literature and culture", "english studies", "entomology", "entrepreneurial studies", "entrepreneurship", "environmental and geotechnical engineering", "environmental engineering", "environmental science", "environmental studies", "epidemiology", "ethics", "european civilization", "european history", "european modern languages", "european studies", "event planning", "exercise and sport science", "exercise science", "family and community services", "family and consumer science", "family science", "family therapy", "fashion", "fashion design", "feminine spirituality", "feminine studies", "film", "film and television", "film directing", "film photography and visual art", "film video and photographic art", "finance", "finance and marketing", "financial accounting", "financial economics", "financial engineering", "financial forensics", "financial forensics and fraud investigation", "financial management", "fine and studio art", "fine art", "fine arts", "finnish", "finnish culture", "finnish language", "finnish language and culture", "finnish language and literature", "finnish language studies", "finnish languages", "finnish literature", "finnish literature and culture", "finnish studies", "fisheries and wildlife science", "flute", "flute performance", "folklore", "folklore studies", "food and nutritional science", "food preparation", "food safety", "food science", "foreign relations", "foreign studies", "forensic chemistry", "forensic computing", "forensic science", "forensics", "forest science", "forest tech", "forestry", "francophone studies", "french", "french culture", "french language", "french language and culture", "french language and literature", "french language studies", "french languages", "french literature", "french literature and culture", "french pastry", "french studies", "fundraising", "fundraising and grantmaking", "game design", "gay and lesbian studies", "gay lesbian studies", "gender and diversity studies", "gender and womens studies", "gender studies", "general agriculture", "general business", "general education", "general engineering", "general medical and health services", "general science", "general social science", "general studies", "genetics", "genomics", "geochemistry", "geography", "geological and geophysical engineering", "geology", "geology and earth science", "geophysics", "geoscience", "geosciences", "geotechnical engineering", "german", "german culture", "german language", "german language and culture", "german language and literature", "german language studies", "german languages", "german literature", "german literature and culture", "german studies", "global health", "global history", "global studies", "government", "government and management", "government and politics", "graphic and printing", "graphic and printing science", "graphic art", "graphic design", "greek", "greek culture", "greek language", "greek language and culture", "greek language and literature", "greek language studies", "greek languages", "greek literature", "greek literature and culture", "greek mythology", "greek studies", "gynecology", "health administration", "health and medical administrative services", "health and medical preparatory programs", "health care", "health care administration", "health education", "health medical professions", "health promotion", "health science", "health service administration", "health services", "healthcare", "healthcare administration", "hebrew", "hebrew culture", "hebrew language", "hebrew language and culture", "hebrew language and literature", "hebrew language studies", "hebrew languages", "hebrew literature", "hebrew literature and culture", "hebrew studies", "hindi", "hindi culture", "hindi language", "hindi language and culture", "hindi language and literature", "hindi language studies", "hindi languages", "hindi literature", "hindi literature and culture", "hindi studies", "hindu", "hindu studies", "historic preservation", "history", "holocaust studies", "homeland security", "horticulture", "hospitality", "hospitality and tourism", "hospitality management", "hotel management", "human development", "human physiology", "human relations", "human resource development", "human resource management", "human resources", "human resources and personnel management", "human resources management", "human services", "human services and community organization", "humanities", "hungarian", "hungarian culture", "hungarian language", "hungarian language and culture", "hungarian language and literature", "hungarian language studies", "hungarian languages", "hungarian literature", "hungarian literature and culture", "hungarian studies", "illustration", "illustraton", "immunology", "indonesian", "indonesian and malay languages", "indonesian culture", "indonesian language", "indonesian language and culture", "indonesian language and literature", "indonesian language studies", "indonesian languages", "indonesian literature", "indonesian literature and culture", "indonesian studies", "industrial administration", "industrial and manufacturing engineering", "industrial and organizational psychology", "industrial design", "industrial engineering", "industrial engineering and operations research", "industrial production tech", "industrial relations", "industrial safety", "industrial sales", "industrial tech", "informatics", "information science", "information science and agronomy", "information science and tech", "information systems", "information systems management", "information tech", "instructional tech", "interactive media", "intercultural and international studies", "interdisciplinary social science", "interdisciplinary studies", "international affairs", "international business", "international commerce", "international communications", "international development", "international development and conflict management", "international economic relations", "international economics", "international finance", "international law", "international relations", "international studies", "investment analysis", "investment banking", "irish studies", "islamic culture", "islamic religion", "islamic studies", "italian", "italian culture", "italian language", "italian language and culture", "italian language and literature", "italian language studies", "italian languages", "italian literature", "italian literature and culture", "italian studies", "japanese", "japanese culture", "japanese language", "japanese language and culture", "japanese language and literature", "japanese language studies", "japanese languages", "japanese literature", "japanese literature and culture", "japanese studies", "jazz", "jazz performance", "journalism", "judaic studies", "kinesiology", "korean", "korean culture", "korean language", "korean language and culture", "korean language and literature", "korean language studies", "korean languages", "korean literature", "korean literature and culture", "korean studies", "labor relations", "labor studies", "landscape architecture", "landscaping", "landscaping and groundskeeping", "language and drama education", "latin", "latin american and caribbean studies", "latin american studies", "law", "law enforcement", "law enforcement executive development", "leadership", "legal administration", "legal studies", "lgbtq studies", "liberal art", "liberal arts", "liberal studies", "library science", "linguistics", "linguistics and comparative language and literature", "literature", "liturgical studies", "logic", "logistics", "management", "management information systems and statistics", "management science", "management studies", "mandarin", "mandarin chinese", "mandarin culture", "mandarin language", "mandarin language and culture", "mandarin language and literature", "mandarin language studies", "mandarin languages", "mandarin literature", "mandarin literature and culture", "mandarin studies", "marine biology", "marine science", "marketing", "masonry", "mass media", "materials engineering and materials science", "materials science", "mathematical modeling", "mathematical science", "mathematics", "mechanical engineering", "mechanical engineering related tech", "mechanical tech", "mechatronics", "mechatronics and automation", "mechatronics engineering", "media art", "media art and entertainment", "media management", "media studies", "medical assisting services", "medical biology", "medical engineering", "medical insurance", "medical tech", "medicine", "medieval and renaissance studies", "medieval studies", "metallurgical engineering", "metaphysics", "meteorology", "microbiology", "middle eastern studies", "military science", "military tech", "mining", "mining and mineral engineering", "mining engineering", "ministry", "modern art", "modern languages", "molecular biology", "molecular biophysics", "multicultural studies", "multimedia", "multimedia journalism", "music", "music education", "mythology", "mythology and folklore", "nanotechnology", "native american studies", "natural resource conservation", "natural resources conservation", "natural resources management", "natural science", "naval architecture", "naval architecture and marine engineering", "naval architecture and ocean engineering", "near and middle eastern studies", "near eastern studies", "network administration", "network and systems administration", "neuroscience", "norwegian", "norwegian culture", "norwegian language", "norwegian language and culture", "norwegian language and literature", "norwegian language studies", "norwegian languages", "norwegian literature", "norwegian literature and culture", "norwegian studies", "nuclear engineering", "nuclear propulsion", "number theory", "nursing", "nursing administration", "nutrition", "nutrition science", "nutritional science", "occupational health", "occupational health and safety", "occupational safety", "occupational safety engineering", "occupational therapy", "oceanography", "operations logistics", "operations logistics and e-commerce", "operations management", "optometry", "orchestral conducting", "organ performance", "organic chemistry", "organization administration", "organizational and professional communications", "organizational communications", "organizational leadership", "organizational management", "orthodontics", "painting", "paleontology", "paralegal", "paralegal studies", "parks and recreation", "parks recreation and leisure studies", "percussion", "performing art", "performing arts", "petroleum engineering", "petroleum geoscience", "petroleum tech", "pharmaceutical administration", "pharmaceutical development", "pharmaceutical science", "pharmacology", "pharmacy", "philosophy", "photography", "physical activity", "physical and health education teaching", "physical education", "physical fitness parks recreation and leisure", "physical science", "physical therapy", "physics", "physiology", "physiotherapy", "piano", "piano performace", "piano performance", "planetary and atmospheric science", "plant science", "plant science and agronomy", "playwriting", "poetry", "police science", "political development", "political science", "political science and government", "politics", "poly sci", "portuguese", "portuguese culture", "portuguese language", "portuguese language and culture", "portuguese language and literature", "portuguese language studies", "portuguese languages", "portuguese literature", "portuguese literature and culture", "portuguese studies", "pre dental", "pre law", "pre law and legal studies", "pre med", "pre optometry", "pre orthodontics", "prelaw", "premed", "premedicine", "product design", "product marketing", "production tech", "project management", "psychology", "public admin", "public administration", "public affairs", "public health", "public law", "public policy", "public relations", "public service", "public service and administration", "publishing", "puppetry", "quality improvement", "queer studies", "rabbinic studies", "rabbinical studies", "radio broadcasting", "radiology", "real estate", "recording art", "recording arts", "recreation administration", "regional planning", "religious education", "religious studies", "retail", "rhetoric", "robotics", "russian", "russian culture", "russian language", "russian language and culture", "russian language and literature", "russian language studies", "russian languages", "russian literature", "russian literature and culture", "russian studies", "scandinavian", "scandinavian culture", "scandinavian language", "scandinavian language and culture", "scandinavian language and literature", "scandinavian language studies", "scandinavian languages", "scandinavian literature", "scandinavian literature and culture", "scandinavian studies", "school student counseling", "science and computer teacher education", "science information", "science tech", "science tech and society", "screen art and cultures", "screen writing", "screenwriting", "sculpture", "secondary teacher education", "semiconductor manufacturing", "serbian", "serbian culture", "serbian language", "serbian language and culture", "serbian language and literature", "serbian language studies", "serbian languages", "serbian literature", "serbian literature and culture", "serbian studies", "slavic culture", "slavic language", "slavic language and culture", "slavic language and literature", "slavic language studies", "slavic languages", "slavic literature", "slavic literature and culture", "slavic studies", "social psychology", "social science", "social sciences", "social services", "social studies", "social work", "sociology", "software development", "software engineering", "soil science", "sommelier", "spanish", "spanish culture", "spanish language", "spanish language and culture", "spanish language and literature", "spanish language studies", "spanish languages", "spanish literature", "spanish literature and culture", "spanish studies", "special education", "special needs education", "speech and hearing science", "speech communications", "speech language pathology", "speech pathology", "speech science", "sport administration", "sport communications", "sport management", "sport philosophy", "sport psychology", "sports and fitness", "sports management", "statistics", "statistics and decision science", "stringed instruments", "studio art", "studio arts", "supply chain management", "sustainability", "sustainability management", "sustainability studies", "swedish", "swedish culture", "swedish language", "swedish language and culture", "swedish language and literature", "swedish language studies", "swedish languages", "swedish literature", "swedish literature and culture", "swedish studies", "talmudic studies", "taxidermy", "teacher education", "teaching", "telecom and electronics", "telecommunications", "television", "television broadcasting", "theater", "theater art", "theater arts", "theatre", "theological studies", "theology", "theology and religious vocations", "tibetan", "tibetan culture", "tibetan language", "tibetan language and culture", "tibetan language and literature", "tibetan language studies", "tibetan languages", "tibetan literature", "tibetan literature and culture", "tibetan studies", "tourism", "tourism management", "toxicology", "transportation science and tech", "travel and tourism management", "travel services management", "treatment therapy professions", "trial advocacy", "turfgrass science", "turkish", "turkish culture", "turkish language", "turkish language and culture", "turkish language and literature", "turkish language studies", "turkish languages", "turkish literature", "turkish literature and culture", "turkish studies", "ukrainian", "ukrainian culture", "ukrainian language", "ukrainian language and culture", "ukrainian language and literature", "ukrainian language studies", "ukrainian languages", "ukrainian literature", "ukrainian literature and culture", "ukrainian studies", "united states history", "urban planning", "urban schooling", "urban social studies", "urban sociology", "urban studies", "veterinary pathology", "veterinary science", "veterinary studies", "vietnamese", "vietnamese culture", "vietnamese language", "vietnamese language and culture", "vietnamese language and literature", "vietnamese language studies", "vietnamese languages", "vietnamese literature", "vietnamese literature and culture", "vietnamese studies", "virology", "visual and performing art", "visual art", "visual communications", "visual effects", "viticulture", "vlsi design", "vlsi engineer", "vocal performance", "vocational counseling", "vocational rehabilitation", "voice", "voice and opera", "web development", "welding", "welding engineering", "wellness management", "wildlife and fisheries science", "wildlife and fishery science", "wildlife science", "wildlife tech", "womens studies", "writing", "writing and culture", "zoology" ], "description": "A list of minors associated with this education object", "items": { "type": "string" } }, "school": { "description": "A dictionary of information for the associated school", "allOf": [ { "$ref": "#/components/schemas/School" } ] }, "start_date": { "type": "string", "format": "date", "description": "Indicates the start period of the object" }, "end_date": { "type": "string", "format": "date", "description": "Indicates the end period of the object" }, "gpa": { "type": "number", "description": "The gpa associated with the given degree" } }, "additionalProperties": false }, "Profiles": { "type": "object", "properties": { "url": { "type": "string", "description": "The url of the social profile" }, "id": { "type": "string", "description": "the persistent id related to this social profile (varies by social network)" }, "network": { "type": "string", "description": "The network the profile exists on" }, "username": { "type": "string", "description": "The username associated with the profile" } }, "additionalProperties": false }, "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" }, "sex": { "type": "string", "description": "The person's sex" }, "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", "description": "A person's current job title derived role" }, "job_title_sub_role": { "type": "string", "description": "A person's job title derived subrole. Each subrole maps to a role" }, "job_title_levels": { "type": "string", "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", "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", "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", "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", "description": "A person's current company's HQ country" }, "job_company_location_continent": { "type": "string", "description": "A person's current company's HQ continent" }, "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", "description": "the current MSA of the person" }, "location_region": { "type": "string", "description": "the current region of the person" }, "location_country": { "type": "string", "description": "the current country of the person" }, "location_continent": { "type": "string", "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" } }, "street_address": { "type": "array", "items": { "$ref": "#/components/schemas/StreetAddress" } }, "experience": { "type": "array", "items": { "$ref": "#/components/schemas/Experience" } }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/Education" } }, "profiles": { "type": "array", "description": "Social media profiles associated with this person profile", "items": { "$ref": "#/components/schemas/Profiles" } }, "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." } }, "additionalProperties": false }, "PersonPreview": { "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" }, "sex": { "type": "string", "description": "The person's sex" }, "linkedin_url": { "type": "string", "format": "url", "description": "Main linkedin profile for this record based on source agreement" }, "job_title": { "type": "string", "description": "A person's current job title" }, "job_title_role": { "type": "string", "description": "A person's current job title derived role" }, "job_title_sub_role": { "type": "string", "description": "A person's job title derived subrole. Each subrole maps to a role" }, "job_title_levels": { "type": "string", "description": "A person's current job title derived levels" }, "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" }, "location_name": { "type": "string", "description": "The current canonical location of the person" }, "first_name": { "type": "boolean", "description": "A boolean representing if PDL's data contains person's first name" }, "middle_initial": { "type": "boolean", "description": "A boolean representing if PDL's data contains person's middle initial" }, "middle_name": { "type": "boolean", "description": "A boolean representing if PDL's data contains person's middle name" }, "last_initial": { "type": "boolean", "description": "A boolean representing if PDL's data contains person's last initial" }, "last_name": { "type": "boolean", "description": "A boolean representing if PDL's data contains person's last name" }, "birth_year": { "type": "boolean", "description": "A boolean representing if PDL's data contains the 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": "boolean", "description": "A boolean representing if PDL's data contains birth date associated with this person profile" }, "linkedin_username": { "type": "boolean", "description": "A boolean representing if PDL's data contains main linkedin username for this record based on source agreement" }, "linkedin_id": { "type": "boolean", "description": "A boolean representing if PDL's data contains main linkedin profile id for this record based on source agreement" }, "facebook_url": { "type": "boolean", "description": "A boolean representing if PDL's data contains facebook profile URL" }, "facebook_username": { "type": "boolean", "description": "A boolean representing if PDL's data contains facebook username" }, "facebook_id": { "type": "boolean", "description": "A boolean representing if PDL's data contains persistent facebook id associated with a person's facebook profile" }, "twitter_url": { "type": "boolean", "description": "A boolean representing if PDL's data contains Twitter URL" }, "twitter_username": { "type": "boolean", "description": "A boolean representing if PDL's data contains Twitter Username" }, "github_url": { "type": "boolean", "description": "A boolean representing if PDL's data contains main github profile for this record based on source agreement" }, "github_username": { "type": "boolean", "description": "A boolean representing if PDL's data contains main github profile username for this record based on source agreement" }, "work_email": { "type": "boolean", "description": "A boolean representing if PDL's data contains current Professional email" }, "personal_emails": { "type": "boolean", "description": "A boolean representing if PDL's data contains a list of all emails tagged as type = personal" }, "mobile_phone": { "type": "boolean", "description": "A boolean representing if PDL's data contains highly confident direct dial mobile phone associated with this person" }, "industry": { "type": "boolean", "description": "A boolean representing if PDL's data contains 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_company_id": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's PDL ID" }, "job_company_size": { "type": "boolean", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1000", "1001-5000", "5001-10000", "10001+" ], "description": "A boolean representing if PDL's data contains a person's current company's size range" }, "job_company_founded": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's founded date" }, "job_company_industry": { "type": "boolean", "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 boolean representing if PDL's data contains a person's current company's industry" }, "job_company_linkedin_url": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's linkedin url" }, "job_company_linkedin_id": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's linkedin id" }, "job_company_facebook_url": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's facebook url" }, "job_company_twitter_url": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's twitter url" }, "job_company_location_name": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ canonical location" }, "job_company_location_locality": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ locality" }, "job_company_location_metro": { "type": "boolean", "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 boolean representing if PDL's data contains a person's current company's HQ metro area" }, "job_company_location_region": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ region" }, "job_company_location_geo": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ geo" }, "job_company_location_street_address": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ street_address" }, "job_company_location_address_line_2": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ address line 2" }, "job_company_location_postal_code": { "type": "boolean", "description": "A boolean representing if PDL's data contains a person's current company's HQ postal code" }, "job_company_location_country": { "type": "boolean", "enum": [ "afghanistan", "albania", "algeria", "american samoa", "andorra", "angola", "anguilla", "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", "côte d'ivoire", "democratic republic of the congo", "denmark", "djibouti", "dominica", "dominican republic", "ecuador", "egypt", "el salvador", "equatorial guinea", "eritrea", "estonia", "eswatini", "ethiopia", "falkland islands", "faroe islands", "fiji", "finland", "france", "french guiana", "french polynesia", "french southern territories", "gabon", "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", "jamaica", "japan", "jersey", "jordan", "kazakhstan", "kenya", "kiribati", "kosovo", "kuwait", "kyrgyzstan", "laos", "latvia", "lebanon", "lesotho", "liberia", "libya", "liechtenstein", "lithuania", "luxembourg", "macau", "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", "new caledonia", "new zealand", "nicaragua", "niger", "nigeria", "niue", "norfolk island", "north korea", "north macedonia", "northern mariana islands", "norway", "oman", "pakistan", "palau", "palestine", "panama", "papua new guinea", "paraguay", "peru", "philippines", "pitcairn islands", "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", "sweden", "switzerland", "syria", "são tomé and príncipe", "taiwan", "tajikistan", "tanzania", "thailand", "the gambia", "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 boolean representing if PDL's data contains a person's current company's HQ country" }, "job_company_location_continent": { "type": "boolean", "enum": [ "africa", "antarctica", "asia", "europe", "north america", "oceania", "south america" ], "description": "A boolean representing if PDL's data contains a person's current company's HQ continent" }, "job_start_date": { "type": "boolean", "description": "A boolean representing if PDL's data contains the start period of the object. Can be accurate to the day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY)" }, "location_locality": { "type": "boolean", "description": "A boolean representing if PDL's data contains the current locality of the person" }, "location_metro": { "type": "boolean", "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 boolean representing if PDL's data contains the current MSA of the person" }, "location_region": { "type": "boolean", "description": "A boolean representing if PDL's data contains the current region of the person" }, "location_country": { "type": "boolean", "enum": [ "afghanistan", "albania", "algeria", "american samoa", "andorra", "angola", "anguilla", "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", "côte d'ivoire", "democratic republic of the congo", "denmark", "djibouti", "dominica", "dominican republic", "ecuador", "egypt", "el salvador", "equatorial guinea", "eritrea", "estonia", "eswatini", "ethiopia", "falkland islands", "faroe islands", "fiji", "finland", "france", "french guiana", "french polynesia", "french southern territories", "gabon", "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", "jamaica", "japan", "jersey", "jordan", "kazakhstan", "kenya", "kiribati", "kosovo", "kuwait", "kyrgyzstan", "laos", "latvia", "lebanon", "lesotho", "liberia", "libya", "liechtenstein", "lithuania", "luxembourg", "macau", "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", "new caledonia", "new zealand", "nicaragua", "niger", "nigeria", "niue", "norfolk island", "north korea", "north macedonia", "northern mariana islands", "norway", "oman", "pakistan", "palau", "palestine", "panama", "papua new guinea", "paraguay", "peru", "philippines", "pitcairn islands", "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", "sweden", "switzerland", "syria", "são tomé and príncipe", "taiwan", "tajikistan", "tanzania", "thailand", "the gambia", "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 boolean representing if PDL's data contains the current country of the person" }, "location_continent": { "type": "boolean", "enum": [ "africa", "antarctica", "asia", "europe", "north america", "oceania", "south america" ], "description": "A boolean representing if PDL's data contains the current continent of the person" }, "location_street_address": { "type": "boolean", "description": "A boolean representing if PDL's data contains the current street address of the person" }, "location_address_line_2": { "type": "boolean", "description": "A boolean representing if PDL's data contains the current address line 2 of the person" }, "location_postal_code": { "type": "boolean", "description": "A boolean representing if PDL's data contains the current postal code of the person" }, "location_geo": { "type": "boolean", "description": "A boolean representing if PDL's data contains the current geo of the person" }, "location_last_updated": { "type": "boolean", "description": "A boolean representing if PDL's data contains the timestamp of the most recent source that agrees with this information" }, "phone_numbers": { "type": "boolean", "description": "A boolean representing if PDL's data contains phone numbers associated with this person profile in E164 format" }, "emails": { "type": "boolean", "description": "A boolean representing if PDL's data contains emails associated with this person profile" }, "interests": { "type": "boolean", "description": "A boolean representing if PDL's data contains interests associated with the profile" }, "skills": { "type": "boolean", "description": "A boolean representing if PDL's data contains skills associated with the profile" }, "location_names": { "type": "boolean", "description": "A boolean representing if PDL's data contains list of all canonical location names associated with the person" }, "regions": { "type": "boolean", "description": "A boolean representing if PDL's data contains list of regions associated with the person" }, "countries": { "type": "boolean", "description": "A boolean representing if PDL's data contains list of countries associated with a person" }, "street_address": { "type": "boolean", "description": "A boolean representing if PDL's data contains street addresses associated with this person profile" }, "experience": { "type": "boolean", "description": "A boolean representing if PDL's data contains job experience associated with this person profile" }, "education": { "type": "boolean", "description": "A boolean representing if PDL's data contains education associated with this person profile" }, "profiles": { "type": "boolean", "description": "A boolean representing if PDL's data contains social media profiles associated with this person profile" } }, "additionalProperties": false }, "PersonRetrieve": { "type": "object", "properties": { "status": { "type": "integer", "enum": [ 200, 400, 401, 402, 404, 405, 429 ], "description": "The return status code for individual Person ID request" }, "data": { "$ref": "#/components/schemas/Profiles" }, "billed": { "type": "boolean", "description": "Defines if the user was billed for this request." }, "metadata": { "type": "object", "description": "User supplied metadata that is returned with the request", "additionalProperties": {} } }, "required": [ "billed", "data", "status" ], "additionalProperties": false }, "PersonRetrieveBulk": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PersonRetrieve" } } }, "additionalProperties": false }, "CompanyLocation": { "type": "object", "properties": { "address_line_2": { "type": "string", "description": "The company's current HQ address line 2" }, "continent": { "type": "string", "description": "The company's current HQ continent" }, "country": { "type": "string", "description": "The company's current HQ country" }, "geo": { "type": "string", "description": "The company's current HQ city-level Geo" }, "locality": { "type": "string", "description": "The company's current HQ locality" }, "metro": { "type": "string", "description": "The company's current HQ metro (US only)" }, "name": { "type": "string", "description": "The company's current HQ location name, generated from our canonical location data with the format locality, region, country" }, "postal_code": { "type": "string", "description": "The company's current HQ postal code" }, "region": { "type": "string", "description": "The company's current HQ region" }, "street_address": { "type": "string", "description": "The company's current HQ street address" } }, "additionalProperties": false }, "Company": { "type": "object", "properties": { "affiliated_profiles": { "type": "array", "description": "A list of company IDs that PDL has flagged as being affiliated and having an association to this company (either parent or child)", "items": { "type": "string" } }, "alternative_names": { "type": "array", "description": "The list of names associated with this company filtered to ensure data quality", "items": { "type": "string" } }, "employee_count": { "type": "integer", "description": "The current integer number of employees working at the company." }, "facebook_url": { "type": "string", "description": "Primary company facebook" }, "founded": { "type": "integer", "description": "The founded year of the company" }, "headline": { "type": "string", "description": "The company's 'headline' summary" }, "id": { "type": "string", "description": "PDL company ID. This is currently non-persistent and generated from the company's primary linkedin username" }, "industry": { "type": "string", "description": "Self reported industry -- the enum is from linkedin's standard industries" }, "linkedin_id": { "type": "string", "description": "Primary company linkedin ID" }, "linkedin_url": { "type": "string", "description": "Primary company linkedin url" }, "location": { "$ref": "#/components/schemas/CompanyLocation" }, "name": { "type": "string", "description": "The company's main common name" }, "profiles": { "type": "array", "description": "A list of all profiles associated with the company", "items": { "type": "string" } }, "size": { "type": "string", "description": "A range representing the number of people working at the company" }, "summary": { "type": "string", "description": "Company description" }, "tags": { "type": "array", "description": "Tags associated with the company", "items": { "type": "string" } }, "ticker": { "type": "string", "description": "Company Ticker, (only for public companies)" }, "twitter_url": { "type": "string", "description": "Primary company twitter url" }, "type": { "type": "string", "description": "The type of the company" }, "website": { "type": "string", "description": "Primary company website" } }, "additionalProperties": false }, "JobTitle": { "type": "object", "properties": { "cleaned_job_title": { "type": "string", "description": "The job title matching the API input job title after being run through our internal job title cleaner." }, "similar_job_titles": { "type": "array", "description": "Up to five of the most contextually similar job titles to the cleaned_job_title determined using PDL’s global resume data.", "items": { "type": "string" } }, "relevant_skills": { "type": "array", "description": "Up to five of the most contextually relevant skills to the cleaned_job_title determined using PDL’s global resume data.", "items": { "type": "string" } }, "id": { "type": "string", "description": "PDL Job Title entity ID. This is currently non-persistent and generated from the cleaned_job_title" } }, "additionalProperties": false }, "SubscriptionResponse": { "type": "object", "properties": { "event_type": { "type": "string", "description": "The type of event to subscribe to" }, "target_url": { "type": "string", "format": "url", "description": "The URL the subscription will be sent to; scheme must be https", "example": "https://callbackapi.example.com/endpoint" }, "headers": { "type": "object", "description": "Custom headers", "example": { "x-custom-header": "very-secure-value" }, "additionalProperties": { "type": "string" } }, "created_timestamp": { "type": "string", "format": "date-time", "description": "The date and time when the subscription was created" }, "id": { "type": "string", "description": "The unique identifier of the subscription" }, "status": { "type": "string", "description": "The status of the subscription" }, "last_verified_timestamp": { "type": "string", "format": "date-time", "description": "Timestamp of most recent target URL verification" } }, "required": [ "created_timestamp", "last_verified_timestamp", "target_url", "event_type", "id", "status" ], "additionalProperties": false }, "SubscriptionRequest": { "type": "object", "properties": { "event_type": { "type": "string", "description": "The type of event to subscribe to" }, "target_url": { "type": "string", "format": "url", "description": "The URL the subscription will be sent to; scheme must be https", "example": "https://callbackapi.example.com/endpoint" }, "headers": { "type": "object", "description": "Custom headers", "example": { "x-custom-header": "very-secure-value" }, "additionalProperties": { "type": "string" } }, "status": { "type": "string", "description": "The status of the subscription" } }, "required": [ "target_url", "event_type" ], "additionalProperties": false } } }, "paths": { "/v5/person/enrich": { "get": { "tags": [ "person" ], "summary": "/person/enrich", "description": "Enrich a person record on a variety of fields", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "pdl_id", "in": "query", "description": "PDL's Person ID value. If provided, it will be the only input used", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "The person's full name, at least first and last", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "The person's first name", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "The person's last name", "schema": { "type": "string" } }, { "name": "middle_name", "in": "query", "description": "The person's middle name", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "A location in which a person lives", "schema": { "type": "string" } }, { "name": "street_address", "in": "query", "description": "A street address in which the person lives", "schema": { "type": "string" } }, { "name": "locality", "in": "query", "description": "A locality in which the person lives", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "A state or region in which the person lives", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "A country in which the person lives", "schema": { "type": "string" } }, { "name": "postal_code", "in": "query", "description": "The postal code in which the person lives", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "A name, website, or social url of a company where the person has worked", "schema": { "type": "string" } }, { "name": "school", "in": "query", "description": "A name, website, or social url of a university or college the person has attended", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "A phone number the person has used", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "An email the person has used", "schema": { "type": "string" } }, { "name": "email_hash", "in": "query", "description": "A sha256 email hash", "schema": { "type": "string" } }, { "name": "profile", "in": "query", "description": "A social profile the person has used. https://docs.peopledatalabs.com/docs/social-networks", "schema": { "type": "string" } }, { "name": "lid", "in": "query", "description": "A LinkedIn numerical ID", "schema": { "type": "string" } }, { "name": "birth_date", "in": "query", "description": "The person's birth date. Either the year, or a full birth date", "schema": { "type": "string" } }, { "name": "min_likelihood", "in": "query", "description": "The minimum likelihood score a response must possess in order to return a 200", "schema": { "type": "integer", "maximum": 10, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "required", "in": "query", "description": "Parameter specifying the fields and data points a response must have to return a 200", "schema": { "type": "string" } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase the person data in 200 responses.", "schema": { "type": "boolean", "default": false } }, { "name": "data_include", "in": "query", "description": "A comma-separated string of fields that you would like the response to include. eg. \"names.clean,emails.address\". Begin the string with a - if you would instead like to exclude the specified fields. If you would like to exclude all data from being returned, use data_include=\"\".", "schema": { "type": "string" } }, { "name": "include_if_matched", "in": "query", "description": "If set to true, includes a top-level (alongside \"data\", \"status\", etc) field \"matched\" which includes a value for each queried field parameter that was \"matched-on\" during our internal query.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Person Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/person/enrich/preview": { "get": { "tags": [ "person" ], "summary": "/person/enrich/preview", "description": "Enrich a person record on a variety of fields and receive a preview record in return", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "The person's full name, at least first and last", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "The person's first name", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "The person's last name", "schema": { "type": "string" } }, { "name": "middle_name", "in": "query", "description": "The person's middle name", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "A location in which a person lives", "schema": { "type": "string" } }, { "name": "street_address", "in": "query", "description": "A street address in which the person lives", "schema": { "type": "string" } }, { "name": "locality", "in": "query", "description": "A locality in which the person lives", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "A state or region in which the person lives", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "A country in which the person lives", "schema": { "type": "string" } }, { "name": "postal_code", "in": "query", "description": "The postal code in which the person lives", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "A name, website, or social url of a company where the person has worked", "schema": { "type": "string" } }, { "name": "school", "in": "query", "description": "A name, website, or social url of a university or college the person has attended", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "A phone number the person has used", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "An email the person has used", "schema": { "type": "string" } }, { "name": "email_hash", "in": "query", "description": "A sha256 email hash", "schema": { "type": "string" } }, { "name": "profile", "in": "query", "description": "A social profile the person has used. https://docs.peopledatalabs.com/docs/social-networks", "schema": { "type": "string" } }, { "name": "lid", "in": "query", "description": "A LinkedIn numerical ID", "schema": { "type": "string" } }, { "name": "birth_date", "in": "query", "description": "The person's birth date. Either the year, or a full birth date", "schema": { "type": "string" } }, { "name": "min_likelihood", "in": "query", "description": "The minimum likelihood score a response must possess in order to return a 200", "schema": { "type": "integer", "maximum": 10, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "required", "in": "query", "description": "Parameter specifying the fields and data points a response must have to return a 200", "schema": { "type": "string" } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase the person data in 200 responses.", "schema": { "type": "boolean", "default": false } }, { "name": "include_if_matched", "in": "query", "description": "If set to true, includes a top-level (alongside \"data\", \"status\", etc) field \"matched\" which includes a value for each queried field parameter that was \"matched-on\" during our internal query.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Person Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonPreview" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/person/identify": { "get": { "tags": [ "person" ], "summary": "/person/identify", "description": "Recover all related profiles for an identity", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "name", "in": "query", "description": "The person's full name, at least first and last", "schema": { "type": "string" } }, { "name": "first_name", "in": "query", "description": "The person's first name", "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "The person's last name", "schema": { "type": "string" } }, { "name": "middle_name", "in": "query", "description": "The person's middle name", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "A location in which a person lives", "schema": { "type": "string" } }, { "name": "street_address", "in": "query", "description": "A street address in which the person lives", "schema": { "type": "string" } }, { "name": "locality", "in": "query", "description": "A locality in which the person lives", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "A state or region in which the person lives", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "A country in which the person lives", "schema": { "type": "string" } }, { "name": "postal_code", "in": "query", "description": "The postal code in which the person lives", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "A name, website, or social url of a company where the person has worked", "schema": { "type": "string" } }, { "name": "school", "in": "query", "description": "A name, website, or social url of a university or college the person has attended", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "A phone number the person has used", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "An email the person has used", "schema": { "type": "string" } }, { "name": "email_hash", "in": "query", "description": "A sha256 email hash", "schema": { "type": "string" } }, { "name": "profile", "in": "query", "description": "A social profile the person has used. https://docs.peopledatalabs.com/docs/social-networks", "schema": { "type": "string" } }, { "name": "lid", "in": "query", "description": "A LinkedIn numerical ID", "schema": { "type": "string" } }, { "name": "birth_date", "in": "query", "description": "The person's birth date. Either the year, or a full birth date", "schema": { "type": "string" } }, { "name": "min_likelihood", "in": "query", "description": "The minimum likelihood score a response must possess in order to return a 200", "schema": { "type": "integer", "maximum": 10, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "required", "in": "query", "description": "Parameter specifying the fields and data points a response must have to return a 200", "schema": { "type": "string" } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase the person data in 200 responses.", "schema": { "type": "boolean", "default": false } }, { "name": "data_include", "in": "query", "description": "A comma-separated string of fields that you would like the response to include. eg. \"names.clean,emails.address\". Begin the string with a - if you would instead like to exclude the specified fields. If you would like to exclude all data from being returned, use data_include=\"\".", "schema": { "type": "string" } }, { "name": "include_if_matched", "in": "query", "description": "If set to true, includes a top-level (alongside \"data\", \"status\", etc) field \"matched\" which includes a value for each queried field parameter that was \"matched-on\" during our internal query.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Profiles Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained either missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/person/search": { "get": { "tags": [ "person" ], "summary": "/person/search", "description": "Search People Data Labs Dataset", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "The content type", "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] } }, { "name": "query", "in": "query", "description": "An Elasticsearch (v7.7) query. See our underlying Elasticsearch mapping for reference.", "schema": { "type": "string" } }, { "name": "sql", "in": "query", "description": "A SQL query of the format: SELECT * FROM person WHERE XXX, where XXX is a standard SQL boolean query involving PDL fields. Any use of column selections or the LIMIT keyword will be ignored.", "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The number of matched records to return for this query if they exist*. Must be between 1 and 100", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "format": "int32", "default": 1 } }, { "name": "from", "in": "query", "description": "An offset value for pagination. Can be a number between 0 and 9999. Pagination can be executed up to a maximum of 10,000 records per query. Be sure to use the \"total\" response field to help discover how many total records exist in the dataset for your query", "schema": { "type": "integer", "maximum": 9999, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "scroll_token", "in": "query", "description": "An offset key for paginating between batches. Can be used for any number of records. Each search API response returns a scroll_token which can be used to fetch the next size records.", "schema": { "type": "string", "default": "" } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase any records returned", "schema": { "type": "boolean", "default": false } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } }, { "name": "dataset", "in": "query", "description": "The dataset category to return records from. Can be multiple comma seperated categories or all", "schema": { "type": "string", "default": "resume" } } ], "responses": { "200": { "description": "Person Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "Request didn't return any records." }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } }, "post": { "tags": [ "person" ], "summary": "/person/search", "description": "Search People Data Labs Dataset", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "The content type", "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] } }, { "name": "query", "in": "query", "description": "An Elasticsearch (v7.7) query. See our underlying Elasticsearch mapping for reference.", "schema": { "type": "string" } }, { "name": "sql", "in": "query", "description": "A SQL query of the format: SELECT * FROM person WHERE XXX, where XXX is a standard SQL boolean query involving PDL fields. Any use of column selections or the LIMIT keyword will be ignored.", "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The number of matched records to return for this query if they exist*. Must be between 1 and 1000 (inclusive)", "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "format": "int32", "default": 1 } }, { "name": "from", "in": "query", "description": "An offset value for pagination. Can be a number between 0 and 9999. Pagination can be executed up to a maximum of 10,000 records per query. Be sure to use the \"total\" response field to help discover how many total records exist in the dataset for your query", "schema": { "type": "integer", "maximum": 9999, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "scroll_token", "in": "query", "description": "An offset key for paginating between batches. Can be used for any number of records. Each search API response returns a scroll_token which can be used to fetch the next size records.", "schema": { "type": "string", "default": "" } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase any records returned", "schema": { "type": "boolean", "default": false } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } }, { "name": "dataset", "in": "query", "description": "The dataset category to return records from. Can be multiple comma seperated categories or all", "schema": { "type": "string", "default": "resume" } } ], "responses": { "200": { "description": "Person Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "Request didn't return any records." }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/person/retrieve/{person_id}": { "get": { "tags": [ "person" ], "summary": "/person/retrieve/", "description": "Retrieves a person based on a PDL ID.", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "person_id", "in": "path", "description": "The ID of a person", "schema": { "type": "string" }, "required": true }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase the person data in 200 responses.", "schema": { "type": "boolean", "default": false } }, { "name": "filter_updated", "in": "query", "description": "Filter out results that have not been updated since the most recent request based on the given key or keys (comma delimited)", "schema": { "type": "string", "enum": [ "job_change,location" ] } }, { "name": "request_version", "in": "query", "description": "Allows for a specific version of a filter_update, bypassing the `last_requested_version`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Person Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonRetrieve" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/person/retrieve/bulk": { "post": { "tags": [ "person" ], "summary": "/person/retrieve/bulk", "description": "Retrieves up to 100 person records based on a PDL ID.", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase the person data in 200 responses.", "schema": { "type": "boolean", "default": false } }, { "name": "filter_updated", "in": "query", "description": "Filter out results that have not been updated since the most recent request based on the given key", "schema": { "type": "string", "enum": [ "job_change" ] } }, { "name": "request_version", "in": "query", "description": "Allows for a specific version of a filter_update, bypassing the `last_requested_version`", "schema": { "type": "string" } } ], "requestBody": { "description": "Request object containing a list of Person IDs.", "content": { "application/json": { "schema": { "properties": { "requests": { "type": "array", "description": "requests contains a list of objects that have a Person ID and optional metadata object." } } } } } }, "responses": { "200": { "description": "Person Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonRetrieveBulk" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/company/enrich": { "get": { "tags": [ "company" ], "summary": "/company/enrich", "description": "Enrich a company", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "The content type", "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] } }, { "name": "name", "in": "query", "description": "The name of the company", "schema": { "type": "string" } }, { "name": "website", "in": "query", "description": "A website the company uses", "schema": { "type": "string" } }, { "name": "pdl_id", "in": "query", "description": "The PLD unique ID", "schema": { "type": "string" } }, { "name": "profile", "in": "query", "description": "A social profile of the company (linkedin/facebook/twitter/crunchbase)", "schema": { "type": "string" } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Company Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/company/search": { "get": { "tags": [ "company" ], "summary": "/company/search", "description": "Search People Data Labs Dataset", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "The content type", "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] } }, { "name": "query", "in": "query", "description": "An Elasticsearch (v7.7) query. See our underlying Elasticsearch mapping for reference.", "schema": { "type": "string" } }, { "name": "sql", "in": "query", "description": "A SQL query of the format: SELECT * FROM company WHERE XXX, where XXX is a standard SQL boolean query involving PDL fields. Any use of column selections or the LIMIT keyword will be ignored.", "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The number of matched records to return for this query if they exist*. Must be between 1 and 100", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "format": "int32", "default": 1 } }, { "name": "from", "in": "query", "description": "An offset value for pagination. Can be a number between 0 and 9999. Pagination can be executed up to a maximum of 10,000 records per query. Be sure to use the \"total\" response field to help discover how many total records exist in the dataset for your query", "schema": { "type": "integer", "maximum": 9999, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase any records returned", "schema": { "type": "boolean", "default": false } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Company Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all searches used)" }, "404": { "description": "Request didn't return any records." }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } }, "post": { "tags": [ "company" ], "summary": "/company/search", "description": "Search People Data Labs Dataset", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "The content type", "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] } }, { "name": "query", "in": "query", "description": "An Elasticsearch (v7.7) query. See our underlying Elasticsearch mapping for reference.", "schema": { "type": "string" } }, { "name": "sql", "in": "query", "description": "A SQL query of the format: SELECT * FROM company WHERE XXX, where XXX is a standard SQL boolean query involving PDL fields. Any use of column selections or the LIMIT keyword will be ignored.", "schema": { "type": "string" } }, { "name": "size", "in": "query", "description": "The number of matched records to return for this query if they exist*. Must be between 1 and 100", "schema": { "type": "integer", "maximum": 100, "minimum": 1, "format": "int32", "default": 1 } }, { "name": "from", "in": "query", "description": "An offset value for pagination. Can be a number between 0 and 9999. Pagination can be executed up to a maximum of 10,000 records per query. Be sure to use the \"total\" response field to help discover how many total records exist in the dataset for your query", "schema": { "type": "integer", "maximum": 9999, "minimum": 0, "format": "int32", "default": 0 } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase any records returned", "schema": { "type": "boolean", "default": false } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Company Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all searches used)" }, "404": { "description": "Request didn't return any records." }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/job_title/enrich": { "get": { "tags": [ "job_title" ], "summary": "/job_title/enrich", "description": "Enrich a job_title", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "Content-Type", "in": "header", "description": "The content type", "schema": { "type": "string", "default": "application/json", "enum": [ "application/json" ] } }, { "name": "job_title", "in": "query", "description": "A job_title to be enriched", "schema": { "type": "string" } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Job Title Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobTitle" } } } }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/autocomplete": { "get": { "tags": [ "autocomplete" ], "summary": "/autocomplete", "description": "Autocompletes a limited amount of fields.", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "field", "in": "query", "description": "Field that autocomplete will be calculated for.", "required": true, "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text that is used as the seed for autocompletion.", "schema": { "type": "string", "default": "" } }, { "name": "size", "in": "query", "description": "Numbers of results returned for autocompletion.", "schema": { "type": "integer", "default": 10 } }, { "name": "pretty", "in": "query", "description": "Whether the output should have human-readable indentation.", "schema": { "type": "boolean", "default": false } }, { "name": "titlecase", "in": "query", "description": "Setting titlecase to true will titlecase the autocompletion data in 200 responses.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Autocompletion completed." }, "400": { "description": "Request contained either missing or invalid parameters" }, "401": { "description": "Request contained a missing or invalid key" }, "402": { "description": "You have reached your account maximum (all matches used)" }, "404": { "description": "No records were found matching your request" }, "405": { "description": "Request method is not allowed on the requested resource" }, "429": { "description": "An error occurred due to requests hitting the API too quick" } } } }, "/v5/subscription/{subscription_id}": { "get": { "tags": [ "subscription" ], "summary": "/subscription/", "description": "Retrieves a subscription based on object ID.", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "subscription_id", "in": "path", "description": "The ID of the subscription", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "The requested subscription" } } }, "delete": { "tags": [ "subscription" ], "summary": "/v5/subscription/", "description": "Deletes a subscription.", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "subscription_id", "in": "path", "description": "The ID of the subscription.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "Deleted subscription" } } }, "put": { "tags": [ "subscription" ], "summary": "/v5/subscription/", "description": "Updates a subscription.", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "subscription_id", "in": "path", "description": "The ID of the subscription.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "description": "A subscription object.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "The updated subscription" } } } }, "/v5/subscription": { "get": { "tags": [ "subscription" ], "summary": "/v5/subscription", "description": "Retrieves a list of subscriptions.", "security": [ { "APIKeyHeader": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "description": "All existing subscriptions" } } }, "post": { "tags": [ "subscription" ], "summary": "/v5/subscription", "description": "Creates a new subscription.", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "description": "A subscription object.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } }, "description": "The created subscription" } } } }, "/v5/person/subjectrequest": { "get": { "summary": "/v5/person/subjectrequest", "description": "Retrieves a CSV file containing the PDL Person IDs that have Opt-ed out of our data.", "security": [ { "APIKeyHeader": [] } ], "parameters": [], "responses": { "200": { "description": "List of PDL IDs to be deleted." }, "503": { "description": "Internal Error of our systems." } } } } }, "openapi": "3.0.3" }