For Developers
Search Entities
GET https://ed.link/api/v2/teams/:team_id/search/:query
Executes parallel search across team-accessible people records, integrations, and sources.
Permissions
Requires the logs.read system permission.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
:team_id | UUID | Yes | The ID of the team. |
:query | String | Yes | Search query string (name, email prefix, or entity identifier). |
Sample Request
const response = await axios.get(
`https://ed.link/api/v2/teams/${team_id}/search/${encodeURIComponent(query)}`,
{
headers: {
authorization: `Bearer ${user_session_token}`
}
}
);
Sample Response
{
"$data": {
"people": [
{
"id": "4a18dc60-5ff0-482a-9e1e-28ebc9735d10",
"first_name": "Sarah",
"last_name": "Connor",
"email": "sarah.connor@oakridge.k12.org"
}
],
"integrations": [
{
"id": "fd8e2612-1329-4d85-bb56-95dcb27d7c92",
"status": "active"
}
],
"sources": [],
"applications": [],
"documentation": []
}
}
