Populi API Endpoints
The Populi integration requires access to Populi’s API v2 endpoints so Element451 can exchange student, person, application, lead, contact, and related record data with Populi.
Element451 connects to Populi using a configured API base URL and API key. The base URL is expected to use Populi’s /api2/ path, and the API key is sent as a Bearer token in the request headers .
The specific endpoints required may vary depending on the scope of the integration.
| Endpoint | Method | Used For |
|---|---|---|
| /applicationtemplates | GET | Retrieve application templates |
| /applications | GET | Retrieve applications, including paginated application results |
| /applications | POST | Create a new application |
| /applications/{application_id} | DELETE | Delete an application |
| /applications/{application_id} | PUT | Update an application |
| /applications/{application_id}/submit | GET | Submit an application |
| /applications/{application_id}/fields | GET | Retrieve application fields |
| /applications/{application_id}/fields/{field_id} | GET | Retrieve details for a specific application field |
| /applications/{application_id}/fields/{field_id} | PUT | Update a specific application field |
| /applications/{application_id}/unlink_person | GET | Unlink an application from a person |
| /applications/{application_id}/link_to_person | POST | Link an application to a person |
| /people/{person_id}/applications | GET | Retrieve applications associated with a person |
| /people/{person_id} | GET | Retrieve a person |
| /people/{person_id} | GET | Retrieve a person with expanded properties |
| /people | GET | Retrieve people, including paginated person results |
| /people | POST | Create a person |
| /people/{person_id} | PUT | Update a person |
| /people/{person_id} | DELETE | Delete a person |
| /people | GET | Retrieve people filtered by info_changed date |
| /people | GET | Search people by email |
| /people/possibleduplicates | GET | Retrieve possible duplicate people |
| /people/{person_id}/addresses | GET | Retrieve addresses for a person |
| /people/{person_id}/addresses | POST | Create an address for a person |
| /people/{person_id}/addresses/{address_id} | PUT | Update an address |
| /races | GET | Retrieve races |
| /people/{person_id}/races | GET | Retrieve races for a person |
| /people/{person_id}/races | POST | Add race / Hispanic status information for a person |
| /people/{person_id}/citizenships | GET | Retrieve citizenship records for a person |
| /people/{person_id}/citizenships | POST | Create citizenship information for a person |
| /people/{person_id}/emailaddresses | GET | Retrieve email addresses for a person |
| /people/{person_id}/emailaddresses | POST | Create an email address |
| /people/{person_id}/emailaddresses/{email_address_id} | PUT | Update an email address |
| /people/{person_id}/phonenumbers | GET | Retrieve phone numbers for a person |
| /people/{person_id}/phonenumbers | POST | Create a phone number |
| /people/{person_id}/phonenumbers/{phone_number_id} | PUT | Update a phone number |
| /degrees | GET | Retrieve degrees |
| /leads | GET | Retrieve leads |
| /people/{person_id}/leads | GET | Retrieve leads for a person |
| /leads/{lead_id} | GET | Retrieve a specific lead |
| /people/{person_id}/leads | POST | Create a lead for a person |
| /people/{person_id}/leads/{lead_id} | PUT | Update a lead |
| /people/{person_id}/leads/{lead_id} | DELETE | Delete a lead |
| /academicterms | GET | Retrieve academic terms |
| /academicterms/{term_id} | GET | Retrieve a specific academic term |
Was this page helpful?