UC Recruit provides a RESTful web service to expose the academic unit hierarchy (schools/departments) information stored in the system. This is a read-only API that allows consumption of the data for integration into other systems for analytics, tracking, and reporting.

If you would like access to the API, please fill out the form here. This form helps us maintain control over who has access to the API and the information contained within.

Working with the API

Requests listed below are prefixed with their necessary HTTP verb.

Making Valid Requests

All requests should use the GET HTTP method. All API requests require HTTP Basic Authentication. Please see your systems administrator for assistance in determining the username and password for your site, or contact UCRecruit-Support@uci.edu.

It is strongly suggested that the following headers be set, or that all requests use a .json suffix to ensure that JSON responses are generated.

‘Accept’ HTTP Header

application/json

Listing the Academic Unit Hierarchy

To list all school and department data:

GET https://recruit.ucx.edu/api/v1/unit_hierarchy

The API presents a list of schools with a list of their departments.  The following fields are present in a successful response:

Fields for schools		Format
abbreviation	The short name of the school	String
address	The address of the school	String
created_at	Date the school was created in the system	String
departments	The departments under the school	Array
external_id	The unique identifier of the school.	String
name	Name of the school	String
updated_at	Date the school was last updated	String

Fields for departments		Format
archived_at	Date the department was archived (de-activated). Active departments will have the null value in this field.	String
created_at	Date the department was created in the system	String
external_id	The unique identifier of the department	String
name	Name of the department	String
updated_at	Date the department was last updated	String