---
title: "Get Contacts"
method: GET
path: "/Contacts"
tags: ["Contacts"]
---

# Get Contacts

`GET /Contacts`

**Requires permissions:** *AcademicStaff* or *AcademicSupport* or *StudentFacing*

Get Contacts with optional pagination, sorting, filtering and includes<br />Supported Includes: `Relations`, `Relations.Contacts` (This can be done infinitely, e.g. `Relations.Contacts.To.Relations.Contacts` or `Relations.Contacts.From.Relations.Contacts`), `InverseRelations`, `InverseRelations.Contacts` (This can be done infinitely, e.g. `InverseRelations.Contacts.To.InverseRelations.Contacts` or `InverseRelations.Contacts.From.InverseRelations.Contacts`), `UserFields`.

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Response `200`

Success - Success

- GetContactsResponse
  - `contacts` Contact[], nullable
    - `contactId` string, guid
    - `misId` string, nullable
    - `externalId` string, nullable
    - `feeId` string, nullable
    - `upi` string, guid, nullable
    - `inUse` boolean
    - `email` string, nullable
    - `dateOfBirth` string, date-time, nullable
    - `occupation` string, nullable
    - `initials` string, nullable
    - `title` string, nullable
    - `forename` string, nullable
    - `preferredName` string, nullable
    - `middleNames` string, nullable
    - `surname` string, nullable
    - `gender` string, nullable
    - `pronouns` string, nullable
    - `addressId` integer, nullable
    - `addressLine1` string, nullable
    - `addressLine2` string, nullable
    - `locality` string, nullable
    - `administrativeArea` string, nullable
    - `country` string, nullable
    - `postcode` string, nullable
    - `mobileNumber` string, nullable
    - `daytimeNumber` string, nullable
    - `eveningNumber` string, nullable
    - `lastUpdated` string, date-time, nullable
    - `updatedBy` string, nullable
    - `appAccess` boolean
    - `letterSalutation` string, nullable
    - `labelSalutation` string, nullable
    - `flag` string, nullable
    - `deceased` boolean
    - `photo` string, nullable
    - `canBeMasqueraded` boolean
    - `relations` Relationship[], nullable
      - `relationshipId` string, guid
      - `fromUPI` string, guid, nullable
      - `toUPI` string, guid, nullable
      - `relationshipName` string, nullable
      - `rank` integer, nullable
      - `billing` boolean
      - `emergency` boolean
      - `medical` boolean
      - `courtOrder` boolean
      - `restricted` boolean
      - `relationshipType` string, nullable
      - `lastUpdated` string, date-time, nullable
      - `updatedBy` string, nullable
      - `createdByApp` boolean
      - `fromPerson` unknown
      - `toPerson` unknown
    - `inverseRelations` Relationship[], nullable
      - `relationshipId` string, guid
      - `fromUPI` string, guid, nullable
      - `toUPI` string, guid, nullable
      - `relationshipName` string, nullable
      - `rank` integer, nullable
      - `billing` boolean
      - `emergency` boolean
      - `medical` boolean
      - `courtOrder` boolean
      - `restricted` boolean
      - `relationshipType` string, nullable
      - `lastUpdated` string, date-time, nullable
      - `updatedBy` string, nullable
      - `createdByApp` boolean
      - `fromPerson` unknown
      - `toPerson` unknown
    - `userFields` UserField[], nullable
      - `userFieldId` string, guid
      - `upi` string, guid, required
      - `displayName` string, nullable
      - `value` string, nullable
      - `lastUpdated` string, date-time, nullable
      - `updatedBy` string, nullable
      - `fromMis` boolean, required
    - `relationshipType` string, nullable
    - `relationshipName` string, nullable
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Explain Error
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/fab57bf5558a/schema)