Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edlink Graph API

Institution-level roster and school data.

Edlink Graph API is one of 12 APIs that Edlink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Graph. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 19 operations across 19 paths, and defines 29 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://ed.link/api/v2.

19 operations 19 paths 29 schemas 19 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://ed.link/api/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Edlink Graph API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Edlink Integration Access Token, User Access Token, or Meta API token passed as a Bearer token.

Paths & Operations 19

Across 19 paths, the API surfaces 19 operations — 19 GET. Each is listed below with its method, path, parameters, and response codes.

Graph 19

Institution-level roster and school data.

GET
/graph/people
List people
listPeople 3 params → 200401
GET
/graph/people/{id}
Get a person
getPerson 1 param → 200401404
GET
/graph/classes
List classes
listClasses 3 params → 200401
GET
/graph/classes/{id}
Get a class
getClass 1 param → 200404
GET
/graph/classes/{id}/enrollments
List enrollments for a class
listClassEnrollments 3 params → 200
GET
/graph/enrollments
List enrollments
listEnrollments 3 params → 200401
GET
/graph/enrollments/{id}
Get an enrollment
getEnrollment 1 param → 200404
GET
/graph/schools
List schools
listSchools 2 params → 200
GET
/graph/schools/{id}
Get a school
getSchool 1 param → 200404
GET
/graph/districts
List districts
listDistricts 2 params → 200
GET
/graph/districts/{id}
Get a district
getDistrict 1 param → 200404
GET
/graph/courses
List courses
listCourses 2 params → 200
GET
/graph/courses/{id}
Get a course
getCourse 1 param → 200404
GET
/graph/sections
List sections
listSections 2 params → 200
GET
/graph/sections/{id}
Get a section
getSection 1 param → 200404
GET
/graph/agents
List agents
listAgents 2 params → 200
GET
/graph/agents/{id}
Get an agent
getAgent 1 param → 200404
GET
/graph/events
List change events
listEvents 2 params → 200
GET
/graph/integrations/{id}
Get integration metadata
getIntegration 1 param → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Person (18 properties), Class (17 properties), Enrollment (15 properties), Section (13 properties). Each schema is shown below with its type and property counts.

Person
object
18 properties
SectionList
object
2 properties
PersonResponse
object
1 property
PersonList
object
2 properties
SectionResponse
object
1 property
Section
object
13 properties
AgentResponse
object
1 property
ClassList
object
2 properties
Class
object
17 properties
DistrictResponse
object
1 property
Integration
object
7 properties
Enrollment
object
15 properties
Error
object
3 properties
EnrollmentResponse
object
1 property
DistrictList
object
2 properties
School
object
11 properties
ClassResponse
object
1 property
SchoolResponse
object
1 property
AgentList
object
2 properties
Agent
object
8 properties
District
object
9 properties
EnrollmentList
object
2 properties
EventList
object
2 properties
CourseResponse
object
1 property
Event
object
6 properties
CourseList
object
2 properties
IntegrationResponse
object
1 property
Course
object
12 properties
SchoolList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edlink-graph-api-openapi.yml Raw ↑

Other APIs Edlink publishes across the network.

Edlink Agents API
Edlink Classes API
Edlink Courses API
Edlink Districts API
Edlink Enrollments API
Edlink Events API
Edlink Integrations API
Edlink People API
Edlink Schools API
Edlink Sections API
Edlink SSO API