Element451Integrations Guide

Ethos Permissions / API Endpoints

Updated Article

The Ethos integration requires a defined set of API permissions to allow Element451 to exchange data with the SIS.

Element451 uses multiple Ethos resources (API endpoints) to:

  • Send data to the SIS
  • Retrieve data from the SIS
  • Sync data sources and supporting values

The specific endpoints required may vary by partner depending on the scope of the integration.


Permission Requirements#

  • Each endpoint must have the appropriate read and/or write access enabled
  • Permissions are typically configured based on Element451’s standard integration best practices
  • Some implementations may require additional endpoints based on custom configurations

It is important to confirm that all required permissions are correctly configured before beginning the integration build.


Verifying Permissions#

Partners can validate access using the Ethos API Key Checker (opens in a new tab).  This tool verifies that the configured API key has access to the required endpoints.

Note: Depending on the volume of data in the SIS, the check may take several minutes to complete


Ethos Resources 
48 rows
Ethos Resources 
NameAccessDescriptionResource Type
admission-populationsReadProvides categories of admission populations for prospective students, which is used as “Student Type” in Element451.Admission
admission-applicationsRead + WriteProvides details about student applications for admission.Admission
academic-periodsReadProvides details about the time periods used by institutions, which is used as “Terms” in Element451.Academic
admission-decisionsRead + WriteProvides details about decisions made on applications for admissionAdmission
academic-programsReadProvides details about the offerings, majors, minors, etc, of an institution. Only sometimes neededAcademic
academic-credentialsReadRelates to the completion of a specified course of study, which is used as “Degrees” in Element451.Academic
academic-disciplinesReadThis entity is used to define academic programs, which is used as “Majors” in Element451Academic
personsRead + WriteInformation related to an individual person record.Person
person-matching-requestsRead + WriteInformation about new person requests that are processed through duplicate prevention matching rules.Person
person-emergency-contactsRead + WriteInformation about people that should be contacted in the event of an emergency situation related to the subject person.Person
addressesRead + WriteInformation on the place where a person is located or may be reached.Person
studentsReadInformation about a person who has, or is eligible to, register/enroll at the institution as a student.Person
person-external-educationRead + WriteInformation about the external institutions associated with a person.Person
person-visasRead + WriteInformation about visas issued to a person.Person
personal-relationshipsRead + WriteInformation related to the relationships between two people.Person
person-holdsReadInformation around the holds related to the person record.Academic
person-hold-typesReadInformation around the hold types defined by the institution.Academic
student-academic-periodsReadInformation about a student for a specified academic period.Academic
student-academic-programsReadInformation about a student for a specified academic program.Academic
educational-institutionsReadProvides information about institutions that provide instructional or education related services.Lookup
student-academic-credentialsReadInformation about the academic credentials the student has been awarded.Academic
student-grade-point-averagesReadInformation about the student’s GPAs. Used by the Enrolled Programs package.Academic
educational-goalsReadProvides a list of user defined educational goals.Lookup
sitesReadProvides information about the physical locations that belong to a given institution, which is used as “Campuses” in Element451.Lookup
citizenship-statusesReadProvides information about the status of being a citizen of a country.Lookup
ethnicitiesReadProvides information about ethnicity groupings as defined by the institution.Lookup
racesReadProvides information about race groupings as defined by the institution.Lookup
alternative-credential-typesReadProvides a valid list of alternative credential types.Lookup
countriesReadProvides a valid list of countries. Only sometimes used.Lookup
person-name-typesReadProvides a way to distinguish between multiple names for the same person.Lookup
address-typesReadProvides a list of valid types of a physical address.Lookup
email-typesReadProvides a list of valid email types.Lookup
phone-typesReadProvides a list of valid phone types.Lookup
student-typesReadProvides a list of valid student types.Lookup
student-statusesReadProvides a list of valid student statuses.Lookup
relationship-typesReadProvides a list of valid relationship types.Lookup
admission-application-status-typesReadProvides a list of valid admission application status types.Lookup
admission-application-typesReadProvides a list of valid types of admission applications.Lookup
visa-typesReadProvides information about the type of an endorsement (visa) on a passport.Lookup
admission-populationsReadProvides the categories of admission populations.Lookup
admission-residency-typesReadProvides a list of admission applicants types of residency.Lookup
admission-decision-typesReadProvides a list of valid admission decision types.Lookup
aptitude-assessmentsReadProvide a list of test score codes.Lookup
student-aptitude-assessmentsWriteInformation about a students tests.Person
consumeReadProvides records when changes happen.Data Export
languagesReadProvide a list of valid languages.Lookup
transcript-typesReadProvide a list of valid transcript types.Lookup
transcript-statusesReadProvides a list of valid transcript statuses.Lookup