For Developers

Search Overview

Search provides a unified query endpoint for the team dashboard and API integrations. It executes parallel lookups across multi-region people directories, integration connections, and data sources.

Result Buckets

The search endpoint returns grouped buckets matching your query:

  • people: Student, teacher, and administrator profiles matching name or email.
  • integrations: Connected school and application integrations.
  • sources: Configured data sources.
  • applications: Developer applications.
  • documentation: Matching developer reference documentation.

JSON Example

{
    "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": []
}