Staff Members

A staff_member object represents a single staff member within a school.

Access: This is a read-only resource managed directly by the school.

Permissions: a school level access token with the staff_members scope is required to access staff member information.

List Staff Members

Returns a list of staff members for the school accociated with the provided access_token.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /staff_members
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Mon, 13 Mar 2017 20:00:00 GMT
Parameter Default Example Description
teachers_only false true

return only staff who are teachers

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /staff_members{?teachers_only,per_page,page}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Mon, 13 Mar 2017 20:00:00 GMT
Payload
{
    "object": "list",
    "total_count": 2,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
        {
            "object": "staff_member",
            "id": 21,
            "first_name": "Anita",
            "middle_name": null,
            "last_name": "Abell",
            "title": "Mrs",
            "email": "Abell@example.com",
            "is_teaching_staff": true
        },
        {
            "object": "staff_member",
            "id": 84,
            "first_name": "Mary",
            "middle_name": "Elizabeth",
            "last_name": "Anderson",
            "title": "Mrs",
            "email": "MAnderson@example.com",
            "is_teaching_staff": false
        }
    ]
}

View a Staff Member

Returns an individual staff member record for the given ID.

Note the If-Modified-Since header is optional (see the page on Conditional Requests for more details).

Request

GET /staff_members/{staff_member_id}
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
If-Modified-Since: Mon, 13 Mar 2017 20:00:00 GMT
Parameter Default Example Description
staff_member_id 1

ID of the Staff Member as an Integer

URI Template: /staff_members/{staff_member_id}

Response 200

Headers
Content-Type: application/json; charset=utf-8
Last-Modified: Mon, 13 Mar 2017 20:00:00 GMT
Payload
{
  "object": "staff_member",
  "id": 21,
  "first_name": "Anita",
  "middle_name": null,
  "last_name": "Abell",
  "title": "Mrs",
  "email": "Abell@example.com",
  "is_teaching_staff": true
}