GET https://ed.link/api/v2/graph/agents
Retrieve a list of all Agents.
Request Parameters
This query allows for filtering results.
This query allows for standard paging parameters.
| Parameter | Location | Type | Description |
|---|---|---|---|
$first | query | number | Returns the first n elements from the list. |
$last | query | number | Returns the last n elements from the list. |
$before | query | uuid | Returns the elements in the list that come before the specified item. |
$after | query | uuid | Returns the elements in the list that come after the specified item. |
It is best practice to use either $first or $last in conjunction with the $next value returned by the API to paginate through results.
Read More About Paging
Developer Guide
Click to Read
Sample Request
axios.get('https://ed.link/api/v2/graph/agents', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"id": "0a5c73b7-ef15-40e2-9295-8540914db235",
"created_date": "2023-04-25T16:46:09.601Z",
"updated_date": "2023-04-25T16:46:09.601Z",
"relationship": "mother",
"flags": ["emergency_contact", "pickup_rights", "legal_guardian", "access_to_records"],
"observer_id": "725b31b5-8563-4b51-8df8-419b222e1779",
"target_id": "787d717b-e57b-4f81-81eb-6cb2450728c9",
"properties": {},
"identifiers": []
},
{
"id": "bb145e91-52b8-4716-8c96-77d36704490d",
"created_date": "2023-04-25T16:46:09.601Z",
"updated_date": "2023-04-25T16:46:09.601Z",
"relationship": "father",
"flags": ["emergency_contact", "pickup_rights", "legal_guardian", "has_custody", "lives_with", "access_to_records", "primary_care_provider"],
"observer_id": "acd0f012-02b1-49c3-8d52-a9c723a06470",
"target_id": "3f64e554-2996-44a3-82ff-7d3c989db625",
"properties": {},
"identifiers": []
},
{
"id": "1b1eb9e3-d5ae-4203-94fb-97021aaf5d3e",
"created_date": "2023-04-25T16:46:09.601Z",
"updated_date": "2023-04-25T16:46:09.601Z",
"relationship": "sister",
"flags": [],
"observer_id": "599ef137-ac17-4c22-a935-174815dc3d1a",
"target_id": "0f23760d-574b-448d-bddc-b85f7635daac",
"properties": {},
"identifiers": []
},
{
"id": "81cef0c6-551c-48d4-837f-853d697ffe94",
"created_date": "2023-04-25T16:46:09.601Z",
"updated_date": "2023-04-25T16:46:09.601Z",
"relationship": "aide",
"flags": ["access_to_records"],
"observer_id": "d3cbfddc-df97-4701-b06b-bf892ea785a8",
"target_id": "3f64e554-2996-44a3-82ff-7d3c989db625",
"properties": {},
"identifiers": []
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}