PPHS API Documentation

Personnel Profiles

API URL: https://api.pphs.usc.edu/personnel_profiles
Description:
List multiple personnel profiles by filter options. Returns: pphs_id, uscpvid, first_name, last_name, credentials, division, position_title, department, email, phone1, research_topics, cv
FiltersDescriptionExamples
limitLimit the number of results. If only one number is provided, it would load the number of records based on that number. If there are two numbers, the first one will be the current offset number, and the second will be the number of records to load. PLEASE NOTE: The API includes the total number of records, "total"https://api.pphs.usc.edu/personnel_profiles?faculty_type=primary&limit=20,10
name_searchfirst and last name separated by a single space https://api.pphs.usc.edu/personnel_profiles?name_search=Thomas
emailA single e-mail on recordhttps://api.pphs.usc.edu/personnel_profiles?email=barkausk@usc.edu
emailsA multiple e-mails separated by a commahttps://api.pphs.usc.edu/personnel_profiles?emails=dthomas@usc.edu,ssussma@usc.edu,andrewz@usc.edu
divisionSingle division namehttps://api.pphs.usc.edu/personnel_profiles?division=health_behavior_research
position_titlematching keywords in position title or internal titlehttps://api.pphs.usc.edu/personnel_profiles?position_title=director
pphs_idunique id for all pphs personnelhttps://api.pphs.usc.edu/personnel_profiles?pphs_id=f28
faculty_typethis filter is for faculty only Options: (primary,part_time_lecturer,adjunct,dual,emeritus,joint)https://api.pphs.usc.edu/personnel_profiles?faculty_type=primary
research_interests_listmatching keywords list of research interestshttps://api.pphs.usc.edu/personnel_profiles?research_interests_list=cancer
fullnamefirst and last name separated by a single space https://api.pphs.usc.edu/personnel_profiles?fullname=Duncan Thomas
research_groupthis will load all individuals in the research group. research group must be paired with a subgrouphttps://api.pphs.usc.edu/personnel_profiles?research_group=ias&subgroup=member
subgroupthis will load specific individuals within a specific research group. subgroup must be paired with a research grouphttps://api.pphs.usc.edu/personnel_profiles?research_group=heal&subgroup=Research Staff
Note:
You can also combine different keywords separated by &.
For example for primary faculty with the word director in their titles: https://api.pphs.usc.edu/personnel_profiles?faculty_type=primary&position_title=director

Single Personnel Profile

API URL: https://api.pphs.usc.edu/single_personnel_profile
Description:
List single personnel profile by filter options. Returns: pphs_id, uscpvid, first_name, last_name, credentials, division, position_title, department, email, ctsi_bio, phone1, quote, education_and_training
FiltersDescriptionExamples
emailA single e-mail on recordhttps://api.pphs.usc.edu/single_personnel_profile?email=barkausk@usc.edu
pphs_idunique id for all pphs personnelhttps://api.pphs.usc.edu/single_personnel_profile?pphs_id=f28

Publications

API URL: https://api.pphs.usc.edu/publications
Description:
List publications based on filters. Returns: title, citation, pubyear, pubmonth, pubday, pmid, pubmed_url, pub_authors
FiltersDescriptionExamples
pphs_idGet publication based on PPHS ID. (This is the most recommended way to get publications.)https://api.pphs.usc.edu/publications?pphs_id=f56
pphs_idsGet publications based on multiple authors. Each PPHS ID separated by a comma.https://api.pphs.usc.edu/publications?pphs_ids=f28,f19,f26
selectfavfiveSelect the top five favorite publications (Must be selected by the faculty members)https://api.pphs.usc.edu/publications?pphs_id=f56&selectfavfive=true
pubyearSelect publications based on publication yearhttps://api.pphs.usc.edu/publications?pphs_id=f89&pubyear=2020

Courses Taught

API URL: https://api.pphs.usc.edu/courses_taught
Description:
List of courses taught. Returns: course_number, course_title
FiltersDescriptionExamples
pphs_idGet courses taught for requested PPHS ID.https://api.pphs.usc.edu/courses_taught?pphs_id=f27

Divisions

API URL: https://api.pphs.usc.edu/divisions
Description:
List of division and related information. Returns: division_id,division_name,division_chief_pphs_id,division_chief_name,division_info,division_keywords,url
FiltersDescriptionExamples
Get a simple list of divisions.https://api.pphs.usc.edu/divisions
listList all divisions and related informationhttps://api.pphs.usc.edu/divisions?list=all
searchList all divisions and related information by keyword searchhttps://api.pphs.usc.edu/divisions?search=prevention

Education Programs

API URL: https://api.pphs.usc.edu/education_programs
Description:
List of division and related information. Returns: id,edu_program,edu_program_info,post_code,divisions,edu_program_name,edu_program_level,track_list,directors,contact_person,contact_phone,contact_email,location,info
FiltersDescriptionExamples
Get a simple list of education programs.https://api.pphs.usc.edu/education_programs
listList all education programs and related informationhttps://api.pphs.usc.edu/education_programs?list=all
post_codeList all education programs and related information by post codehttps://api.pphs.usc.edu/education_programs?post_code=1036

Faculty Recruitment

API URL: https://api.pphs.usc.edu/faculty_recruitment
Description:
Faculty recruitment listing. Returns: id,recruitment_type,req_number,position_title,url,created_date
FiltersDescriptionExamples
List all recruitment oppotunities.https://api.pphs.usc.edu/faculty_recruitment
recruitment_typeList recruitment type (faculty, staff, student).https://api.pphs.usc.edu/faculty_recruitment?recruitment_type=faculty
req_numberList recruitment by REQ number.https://api.pphs.usc.edu/faculty_recruitment?req_number=REQ20099305
req_numberList recruitment by recruiter PPHS ID.https://api.pphs.usc.edu/faculty_recruitment?recruiter_pphs_id=f13

Faculty Types

API URL: https://api.pphs.usc.edu/faculty_types
Description:
List of faculty types
FiltersDescriptionExamples
Get a simple list of faculty types.https://api.pphs.usc.edu/faculty_types

Social Media and Websites

API URL: https://api.pphs.usc.edu/faculty_types
Description:
List education history of a selected faculty by PPHS ID. Returns: school, location, degree, field_of_study, graduation_date
FiltersDescriptionExamples
pphs_idGet education history for requested PPHS ID.https://api.pphs.usc.edu/education_history?pphs_id=f32