Crimson Education

Crimson App API

The backend API behind the Crimson App student and mentor platform. There is no provider-published OpenAPI or public developer portal; the surface is documented and exercised through the first-party TypeScript SDK @crimson-education/sdk on npm, which names concrete REST paths under /roadmap/* and /api/v1/* (missions, action items, reflections, roadmap context, mission library, grade templates, package items, tutors, bookings, student profile, account and Indigo identity) plus a token-gated GraphQL endpoint at /graphql. Access is by Auth0 bearer JWT, a server-to-server crimsonauthkey service key, or an OAuth 2.0 authorization-code with PKCE flow the SDK implements but whose backend endpoints the SDK documents as not yet deployed.

GitHub

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/crimson-education/refs/heads/main/authentication/crimson-education-authentication.yml

Other Resources

🔗
SDKs
https://raw.githubusercontent.com/api-evangelist/crimson-education/refs/heads/main/packages/crimson-education-packages.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/crimson-education/refs/heads/main/apis.yml

API entry from apis.yml

apis.yml Raw ↑ 
name: Crimson App API
description: The backend API behind the Crimson App student and mentor platform. There is no provider-published
  OpenAPI or public developer portal; the surface is documented and exercised through the first-party
  TypeScript SDK @crimson-education/sdk on npm, which names concrete REST paths under /roadmap/* and /api/v1/*
  (missions, action items, reflections, roadmap context, mission library, grade templates, package items,
  tutors, bookings, student profile, account and Indigo identity) plus a token-gated GraphQL endpoint
  at /graphql. Access is by Auth0 bearer JWT, a server-to-server crimsonauthkey service key, or an OAuth
  2.0 authorization-code with PKCE flow the SDK implements but whose backend endpoints the SDK documents
  as not yet deployed.
humanURL: https://www.npmjs.com/package/@crimson-education/sdk
baseURL: https://api.app.crimsoneducation.io
tags:
- Education
- Admissions
- Roadmap
- Tasks
- Tutoring
properties:
- type: SDKs
  url: packages/crimson-education-packages.yml
- type: Authentication
  url: authentication/crimson-education-authentication.yml