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 People API

Students, teachers, and other people.

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

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

This API exposes 2 operations across 2 paths, and defines 4 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.

2 operations 2 paths 4 schemas 2 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 People 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 2

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

People 2

Students, teachers, and other people.

GET
/graph/people
List people
listPeople 3 params → 200401
GET
/graph/people/{id}
Get a person
getPerson 1 param → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Person (18 properties), Error (3 properties), PersonList (2 properties), PersonResponse (1 property). Each schema is shown below with its type and property counts.

Person
object
18 properties
PersonResponse
object
1 property
PersonList
object
2 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edlink-people-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 Graph API
Edlink Integrations API
Edlink Schools API
Edlink Sections API
Edlink SSO API