API Documentation
This document will provide examples and resources that one can follow to use the People API. This API updates Monday-Thursday at 5:00pm PST.
Base URL:
https://people.llnl.gov/LLNL/sq9CNbsiBjceDVrC
Grabbing user rodgers31 profile data
GET https://people.llnl.gov/LLNL/sq9CNbsiBjceDVrC/user/user/?filter[name]=rodgers31&include=people_profile_profiles&jsonapi_include=1
Parameters to specify
- filter[name] - OUN
- include - people_profile_profiles
- name - OUN
- mail - Email
- field_display_name - Last Name, First Name
- field_first_name - First Name
- field_last_name - Last Name
- field_payroll_code - Payroll Code
- field_phone - Phone Number
- people_profile_profiles
- id - used to grab people image
- changed - Last updated date
- field_additional_information - Additional Information
- field_awards - Awards
- field_biography - Biography
- field_display_organization* - Boolean to display organization *Field shows if user allows organization to be displayed, we do not provide organization in the API
- field_education - Education
- field_pronouns - Pronouns
- field_publications - Publications
- field_title - Job Title
Grabbing user rodgers31 image
GET https://people.llnl.gov/LLNL/sq9CNbsiBjceDVrC/profile/people_profile?include=field_default_image&jsonapi_include=1&filter[id]=00e6c14f-420c-49d9-8d37-3de48f78cc35
Paramters to specify
- filter[id] - ID grabbed from previous query
- include - field_default_image
- uri
- url - path to attach to end of url for image
Grabbing all users from Payroll code 9540
GET https://people.llnl.gov/LLNL/sq9CNbsiBjceDVrC/user/user/?filter[field_payroll_code]=9540&include=people_profile_profiles&jsonapi_include=1
Paramters to specify
- filter[field_payroll_code] - Payroll code to query by
- include - people_profile_profiles
Optional Parameters
- page[limit] - Default and Max are 50
- offset - Defaults to 0
Additional Resources
Questions or Concerns
Please email webmastercomp@llnl.gov if you have and questions or concerns with the People API