Skip to main content

GOFA Lessons API

This section documents the available cloud function endpoints for the GOFA Lessons API. Each endpoint is designed for authorized GOFA clients to interact with lesson, plan, and play data within the GOFA Lessons experience.

Endpoints

EndpointDescriptionDocumentation Link
/lessonsFetch all lessons associated with a client.GET /lessons
/lesson/{id}Fetch details of a single lesson by lessonId.GET /lesson
/plansFetch all lesson plans associated with a client.GET /plans
/play/{id}Fetch a specific user's lesson play by playId.GET /play
/plan-play/{id}Fetch a specific user's plan play by planPlayId.GET /plan-play
/userFetch a specific user's activity data, including lesson plays and plan plays.GET /user

All endpoints require authentication via Bearer token and client credentials. See each linked document for detailed request/response formats, error handling, and rate limiting policies.


Note:

  • Keep your clientSecret secure and never expose it in client-side code.
  • All timestamps are returned in Unix epoch format with seconds and nanoseconds for precision.
  • Rate limiting applies: 60 requests/minute per client, with burst up to 100.

For more details, refer to the individual endpoint documentation above.