Skip to main content Skip to navigation

List relationship agents by type

Search amongst all members known to Tabula for those who act as the provided relationship agent with at least one student.

Inactive members will be filtered out at query time.

Permission requirements

The user must have Permissions.Profiles.StudentRelationship.Read ("View a student relationship") on PermissionsTarget.Global.

Information about API permissions



URL substitution variables

:studentRelationshipTypeId The required relationship type, e.g. personalTutor. Valid types are available in the documentation or via API request: GET /v1/relationships.

Example request


Response parameters

An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 200 OK and the following parameters:

success Boolean true
status The string "ok"
agents Array of matching agents, with keys for universityId, firstName and lastName.

Example response

"firstName": "Reynard",
"lastName": "Fox",
"universityId": "1234567"

Tabula API Methods