For Developers

List Agents

GET https://ed.link/api/v2/graph/people/:person_id/agents

Retrieve a list of Agents that reference the specified Person in either the observer_id or target_id field.

Request Parameters

This query allows for filtering results.

This query allows for standard paging parameters.

ParameterLocationTypeDescription
person_idurlstring

The UUID of the desired Person.

$firstquerynumber

Returns the first n elements from the list.

$lastquerynumber

Returns the last n elements from the list.

$beforequeryuuid

Returns the elements in the list that come before the specified item.

$afterqueryuuid

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.

Sample Request

axios.get('https://ed.link/api/v2/graph/people/63acc741-7633-453c-9bfd-75ae1ac34533/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": "63acc741-7633-453c-9bfd-75ae1ac34533",
            "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": "63acc741-7633-453c-9bfd-75ae1ac34533",
            "properties": {},
            "identifiers": []
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}