Contacts

A contact object represents a student contact (e.g. parent/guardian).

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

Permissions: a school level access token with the contacts scope is required to access contact information.

List Contacts

Returns a list of contacts that match the given set of filters. Contacts are returned in name order.

Request

GET /contacts
Headers
Accept: application/vnd.assembly+json; version=1
Authorization: Bearer b2s7a9s8BQokikJOvBiI2HlWgH4olfQ2
Parameter Default Example Description
student_id 1

filter by student

per_page 100 25

number of results to return

page 1 2

page number to return

URI Template: /contacts

Response 200

Headers
Content-Type: application/json; charset=utf-8
Payload
{
    "object": "list",
    "total_count": 20,
    "total_pages": 1,
    "current_page": 1,
    "prev_page": null,
    "next_page": null,
    "data": [
      {
        "object": "contact",
        "id": 1,
        "first_name": "F",
        "middle_name": null,
        "last_name": "ABBOTT",
        "gender": "M",
        "title": "Mr",
        "salutation": "Mr F ABBOTT",
        "emails": [
          {
            "object": "email",
            "id": 1,
            "email": "FAbbott@example.com",
            "type": "Home",
            "is_primary": true
          },
          {
            "object": "email",
            "id": 2,
            "email": "FAbbott@test.com",
            "type": "Other",
            "is_primary": false
          }
        ],
        "telephone_numbers": [
          {
            "object": "telephone_number",
            "id": 20,
            "telephone_number": "01632 6",
            "type": "Work",
            "is_primary": false
          }
        ],
        "students": [
          {
            "student_id": 3,
            "relationship": {
              "object": "relationship",
              "relationship_type": "Mother",
              "priority": 1,
              "parental_responsibility": true
            }
          }
        ]
      }
    ]
}