Agents Overview

By Jaron Pate

Last Updated October 8th, 2025

An Agent describes the relationship between two people, and is typically used to represent a connection between a student and their parent or guardian. If a data source provides emergency contacts, this is how they are represented in Edlink.

Properties

Property	Type	Description
`id`	`string`	The UUID for the object. $filter operators: `equals` `in` `not in`
`relationship`	`Relationship`	The relationship between the observer and the target.
`flags`	`AgentFlag[]`	Flags associated with the agent.
`properties`	`object`	Non-standard properties that may be of interest to the developer.
`identifiers`	`Identifier[]`	Additional IDs associated with the object.
`observer_id`	`string`	The UUID of the Person who acts as the observer in the relationship. Typically, this is a parent or guardian. $expand: `observer` $filter operators: `equals` `in` `not in`
`target_id`	`string`	The UUID of the Person who acts as the target in this relationship. Typically, this is a student. $expand: `target` $filter operators: `equals` `in` `not in`

JSON Example

{
    "id": "0a5c73b7-ef15-40e2-9295-8540914db235",
    "created_date": "2023-04-25T16:46:09.601Z",
    "updated_date": "2023-04-25T16:46:09.601Z",
    "relationship": "other",
    "flags": ["emergency_contact", "pickup_rights", "legal_guardian", "has_custody", "lives_with", "access_to_records"],
    "observer_id": "725b31b5-8563-4b51-8df8-419b222e1779",
    "target_id": "787d717b-e57b-4f81-81eb-6cb2450728c9",
    "properties": {},
    "identifiers": []
}

Supported Providers

Provider	Support
aspen	✅
classgather	✅
classlink	✅
oneroster	✅
rapididentity	✅
genesis	✅
sapphire	✅
rediker	✅
renweb	✅
synergy	✅
frontline	✅
banner	✅
tyler	✅
ascender	✅
aequitas	✅
aeries	✅
blackbaud	✅
clever	✅
csv	✅
edfi	✅
facts	✅
google	✅
illuminate	✅
powerschool	✅
schoology	✅
bromcom	✅
skyward	✅
veracross	✅
qmlativ	✅
managebac	✅
infinitecampus	✅
wonde	✅