Edlink Graph API

openapi: 3.2.0
info:
  title: Edlink Graph API
  description: The Edlink API provides a unified, normalized interface to school roster and learning data across hundreds of SIS and LMS source systems.
  termsOfService: https://ed.link/legal/terms
  contact:
    name: Edlink Support
    url: https://ed.link/docs
    email: support@ed.link
  version: '2.0'
servers:
- url: https://ed.link/api/v2
  description: Edlink API v2
security:
- bearerAuth: []
tags:
- name: Graph
  description: Institution-level roster and school data.
paths:
  /graph/people:
    get:
      operationId: listPeople
      tags:
      - Graph
      summary: List people
      description: Returns a paginated list of all people (students, teachers, staff, guardians, administrators) shared with the integration.
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      - $ref: '#/components/parameters/Before'
      responses:
        '200':
          description: A paginated list of people.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /graph/people/{id}:
    get:
      operationId: getPerson
      tags:
      - Graph
      summary: Get a person
      description: Returns a single person by Edlink UUID.
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single person.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/classes:
    get:
      operationId: listClasses
      tags:
      - Graph
      summary: List classes
      description: Returns a paginated list of all classes shared with the integration.
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      - $ref: '#/components/parameters/Before'
      responses:
        '200':
          description: A paginated list of classes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /graph/classes/{id}:
    get:
      operationId: getClass
      tags:
      - Graph
      summary: Get a class
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single class.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/classes/{id}/enrollments:
    get:
      operationId: listClassEnrollments
      tags:
      - Graph
      summary: List enrollments for a class
      parameters:
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: Enrollments within the class.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentList'
  /graph/enrollments:
    get:
      operationId: listEnrollments
      tags:
      - Graph
      summary: List enrollments
      description: Returns a paginated list of enrollments describing the relationship between people and classes.
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      - $ref: '#/components/parameters/Before'
      responses:
        '200':
          description: A paginated list of enrollments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /graph/enrollments/{id}:
    get:
      operationId: getEnrollment
      tags:
      - Graph
      summary: Get an enrollment
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single enrollment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/schools:
    get:
      operationId: listSchools
      tags:
      - Graph
      summary: List schools
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: A paginated list of schools.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchoolList'
  /graph/schools/{id}:
    get:
      operationId: getSchool
      tags:
      - Graph
      summary: Get a school
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single school.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchoolResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/districts:
    get:
      operationId: listDistricts
      tags:
      - Graph
      summary: List districts
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: A paginated list of districts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistrictList'
  /graph/districts/{id}:
    get:
      operationId: getDistrict
      tags:
      - Graph
      summary: Get a district
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single district.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistrictResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/courses:
    get:
      operationId: listCourses
      tags:
      - Graph
      summary: List courses
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: A paginated list of courses.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseList'
  /graph/courses/{id}:
    get:
      operationId: getCourse
      tags:
      - Graph
      summary: Get a course
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single course.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/sections:
    get:
      operationId: listSections
      tags:
      - Graph
      summary: List sections
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: A paginated list of sections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectionList'
  /graph/sections/{id}:
    get:
      operationId: getSection
      tags:
      - Graph
      summary: Get a section
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single section.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SectionResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/agents:
    get:
      operationId: listAgents
      tags:
      - Graph
      summary: List agents
      description: Returns the source connection agents that feed data into the integration.
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: A paginated list of agents.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentList'
  /graph/agents/{id}:
    get:
      operationId: getAgent
      tags:
      - Graph
      summary: Get an agent
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: A single agent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '404':
          $ref: '#/components/responses/NotFound'
  /graph/events:
    get:
      operationId: listEvents
      tags:
      - Graph
      summary: List change events
      description: Returns a stream of create, update, and delete events for roster objects to support incremental synchronization.
      parameters:
      - $ref: '#/components/parameters/First'
      - $ref: '#/components/parameters/After'
      responses:
        '200':
          description: A paginated list of change events.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventList'
  /graph/integrations/{id}:
    get:
      operationId: getIntegration
      tags:
      - Graph
      summary: Get integration metadata
      description: Returns metadata about the integration tied to the current access token, including provider and status.
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Integration metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationResponse'
components:
  schemas:
    CourseList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Course'
        $next:
          type:
          - string
          - 'null'
    PersonResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Person'
    Class:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        picture_url:
          type:
          - string
          - 'null'
        state:
          type: string
          description: Lifecycle state such as active or inactive.
        locale:
          type:
          - string
          - 'null'
        time_zone:
          type:
          - string
          - 'null'
        grade_levels:
          type: array
          items:
            type: string
        subjects:
          type: array
          items:
            type: string
        periods:
          type: array
          items:
            type: string
        session_ids:
          type: array
          items:
            type: string
            format: uuid
        course_id:
          type:
          - string
          - 'null'
          format: uuid
        school_id:
          type:
          - string
          - 'null'
          format: uuid
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
    DistrictResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/District'
    CourseResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Course'
    EnrollmentList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Enrollment'
        $next:
          type:
          - string
          - 'null'
    SchoolResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/School'
    SectionResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Section'
    EventList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        $next:
          type:
          - string
          - 'null'
    Error:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
        code:
          type: integer
    Course:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        name:
          type: string
        code:
          type:
          - string
          - 'null'
        grade_levels:
          type: array
          items:
            type: string
        subjects:
          type: array
          items:
            type: string
        session_id:
          type:
          - string
          - 'null'
          format: uuid
        school_id:
          type:
          - string
          - 'null'
          format: uuid
        district_id:
          type:
          - string
          - 'null'
          format: uuid
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
    AgentResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Agent'
    SchoolList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/School'
        $next:
          type:
          - string
          - 'null'
    IntegrationResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Integration'
    Section:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        picture_url:
          type:
          - string
          - 'null'
        state:
          type: string
        locale:
          type:
          - string
          - 'null'
        time_zone:
          type:
          - string
          - 'null'
        periods:
          type: array
          items:
            type: string
        class_id:
          type:
          - string
          - 'null'
          format: uuid
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
    Person:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        first_name:
          type:
          - string
          - 'null'
        middle_name:
          type:
          - string
          - 'null'
        last_name:
          type:
          - string
          - 'null'
        display_name:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        picture_url:
          type:
          - string
          - 'null'
        roles:
          type: array
          items:
            type: string
          description: One or more roles such as student, teacher, administrator, staff, guardian, district, observer.
        demographics:
          type:
          - object
          - 'null'
        grade_levels:
          type: array
          items:
            type: string
        graduation_year:
          type:
          - string
          - 'null'
        district_id:
          type:
          - string
          - 'null'
          format: uuid
        school_ids:
          type: array
          items:
            type: string
            format: uuid
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
          description: Non-standard custom properties from the source system.
    DistrictList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/District'
        $next:
          type:
          - string
          - 'null'
    PersonList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Person'
        $next:
          type:
          - string
          - 'null'
    ClassList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Class'
        $next:
          type:
          - string
          - 'null'
    SectionList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Section'
        $next:
          type:
          - string
          - 'null'
    District:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        name:
          type: string
        locale:
          type:
          - string
          - 'null'
        time_zone:
          type:
          - string
          - 'null'
        location:
          type:
          - object
          - 'null'
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
    ClassResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Class'
    Integration:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        provider:
          type: string
          description: The source provider, such as Clever, ClassLink, Google Classroom, Canvas, Schoology, PowerSchool.
        status:
          type: string
        team_id:
          type:
          - string
          - 'null'
          format: uuid
        properties:
          type: object
    AgentList:
      type: object
      properties:
        $data:
          type: array
          items:
            $ref: '#/components/schemas/Agent'
        $next:
          type:
          - string
          - 'null'
    School:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        name:
          type: string
        grade_levels:
          type: array
          items:
            type: string
        locale:
          type:
          - string
          - 'null'
        time_zone:
          type:
          - string
          - 'null'
        location:
          type:
          - object
          - 'null'
        district_id:
          type:
          - string
          - 'null'
          format: uuid
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
    Enrollment:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        start_date:
          type:
          - string
          - 'null'
          format: date
        end_date:
          type:
          - string
          - 'null'
          format: date
        role:
          type: string
          description: The person's role in the class, such as student or teacher.
        primary:
          type:
          - boolean
          - 'null'
          description: Indicates the primary teacher, when applicable.
        state:
          type: string
          description: Current enrollment state.
        person_id:
          type: string
          format: uuid
        class_id:
          type: string
          format: uuid
        section_id:
          type:
          - string
          - 'null'
          format: uuid
        final_letter_grade:
          type:
          - string
          - 'null'
        final_numeric_grade:
          type:
          - number
          - 'null'
        identifiers:
          type: array
          items:
            type: object
        properties:
          type: object
    Agent:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        updated_date:
          type: string
          format: date-time
        name:
          type: string
        type:
          type: string
          description: The source connection type the agent represents.
        status:
          type: string
        district_id:
          type:
          - string
          - 'null'
          format: uuid
        properties:
          type: object
    EnrollmentResponse:
      type: object
      properties:
        $data:
          $ref: '#/components/schemas/Enrollment'
    Event:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_date:
          type: string
          format: date-time
        type:
          type: string
          description: The change type, such as created, updated, or deleted.
        target_type:
          type: string
          description: The object type affected, such as person, class, or enrollment.
        target_id:
          type: string
          format: uuid
        integration_id:
          type:
          - string
          - 'null'
          format: uuid
  responses:
    Unauthorized:
      description: Missing or invalid access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    Before:
      name: $before
      in: query
      required: false
      description: Cursor for fetching the page before this value.
      schema:
        type: string
    First:
      name: $first
      in: query
      required: false
      description: Number of records to return per page (pagination).
      schema:
        type: integer
        default: 100
        maximum: 10000
    Id:
      name: id
      in: path
      required: true
      description: Edlink UUID of the resource.
      schema:
        type: string
        format: uuid
    After:
      name: $after
      in: query
      required: false
      description: Cursor for fetching the page after this value.
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Edlink Integration Access Token, User Access Token, or Meta API token passed as a Bearer token.