Skip to content

McCoy API Documentation

Welcome to the McCoy Learning Platform API. This documentation covers authentication, course content access, learner lookup, plan-based provisioning, Surface embedding, and student progress reporting for B2B partners.

Base URL

https://api.mccoy.org/api/v1
Guide Description
Authentication API key authentication
Course Content Accessing courses and topics
Learner Directory Finding existing learners and public learner_id values
Plan-Based Provisioning Creating plans and provisioning learners by API
Surface Embedding Embedding Surface in your portal with backend-created sign-in links
Progress Reporting Reading student progress

Authentication

All API requests require an API key. Include it in the X-Api-Key header. API keys are scoped to one tenant; responses only include courses, plans, learners, and progress for that tenant.

curl -X GET "https://api.mccoy.org/api/v1/courses" \
  -H "X-Api-Key: ak-xxxxxxxx_yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"

See Authentication for details.

Response Format

Successful responses include a data object or array. List responses may also include pagination.

{
  "data": { },
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total_items": 100,
    "total_pages": 2,
    "has_next": true,
    "has_prev": false
  },
}

Errors include an error object:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}

Need Help?

Contact the McCoy team at support@mccoy.org for support with your integration.