This is an old revision of the document!


/api/administrators

:!: This feature is scheduled for release by the end of November 2018

HEAD, GET

List administrator accounts in the system along with basic data. The number of administrators is represented in the X-Count header - use the HEAD request to simply count the number of administrators. Use the GET request to actually fetch them.

Syntax

GET /api/administrators
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1234
X-Count: 123

Response example

{
  "1": {
      "name": "Joe Smith",
      "email": "joe.smith@example.com",
      "phone": "123456789",
      "function": "Head of Admissions"
  },
  "2": {
      "name": "John Doe",
      "email": "john.doe@example.com",
      "phone": null,
      "function": "Marketing Specialist"
  }
}