To fetch a paginated list of faculty profiles or search for a specific faculty profile, use the profiles#search endpoint. This endpoint takes pagination parameters in a JSON payload and returns a results set in a "profiles" array. Each profile object will contain basic information about the faculty member, upcoming events, current appointments, and profile ranks.

Example:

POST => /10668/profiles/search
BODY:
{
 "filter":{
 "page": 1,
 "search_term": "test"
 }
}

To view a specific faculty profile, you can use one of three different endpoints:

1. profiles#show
   

   For the profiles#show endpoint, you will need to first retrieve the ID of the profile from the paginated list of profiles.

    
2. profiles#by_email
   

   For the profiles#by_email endpoint, you will need the email address associated with the given profile.

    
3. profiles#by_dossier
   

   For the profiles#by_dossier endpoint, you will need the PID -- a unique identifier generated for a given user account in Interfolio.

    

You can also retrieve a given user's PID in IAM API using the information here on how to view a user in this article on provisioning users and product access. Once you have one of those identifiers, you can run a simple GET call to the given endpoint, and the API will respond with the profile object.

Examples

GET => /10668/profiles/1432

GET => /10668/profiles/by_email?email=testuser@interfolio.com

GET => /10668/profiles/by_dossier?dossier_pid=2413576