---
title: "API reference"
description: "Complete inventory of the BlendX APIs used by a discovery storefront or external enrollment integration."
source: "https://docs.blend-ed.com/blendx-discovery/api-reference/"
---

# API reference

All paths are relative to `https://<LMS_HOST>`. This page is the complete client-facing route inventory covered by this guide.

## Discovery API
These 14 endpoints accept an authenticated user or the server-side `clientapisecret`, except where the identity column states both are required.

| Method | Endpoint | Purpose | Identity |
| --- | --- | --- | --- |
| `GET` | `/blendxapi/discovery/courses/` | List, search, filter, and order all published courses. | User or client secret |
| `GET` | `/blendxapi/discovery/course/{openedx_course_id}/` | Get one course and its full or summary data. | User or client secret |
| `GET` | `/blendxapi/discovery/course-outline/{openedx_course_id}/` | Get a course’s section and subsection outline. | User or client secret |
| `POST` | `/blendxapi/discovery/courses/effort/` | Calculate effort for up to 50 course keys. | User or client secret |
| `POST` | `/blendxapi/discovery/courses/is-new/` | Check new-course status for up to 100 course keys. | User or client secret |
| `GET` | `/blendxapi/discovery/check-enrollment/{openedx_course_id}/` | Check the current learner’s enrollment and mode. | Learner session for a meaningful result |
| `GET` | `/blendxapi/discovery/programs/` | List, search, filter, and order all published programs. | User or client secret |
| `GET` | `/blendxapi/discovery/program/{program_id}/` | Get one program and its child courses. | User or client secret |
| `GET` | `/blendxapi/discovery/tags/` | List tags and optionally their courses and programs. | User or client secret |
| `GET` | `/blendxapi/discovery/organisations/` | List organisation identity and branding data. | User or client secret |
| `GET` | `/blendxapi/discovery/marketing-page-metadata/` | Get organisation-defined marketing metadata. | User or client secret |
| `GET` | `/blendxapi/discovery/user/` | Determine whether the forwarded LMS session is signed in. | Client secret; optional learner session |
| `POST` | `/blendxapi/discovery/guest/checkout/` | Check out for an email address without an LMS session. | Client secret; signed-in users rejected |
| `POST` | `/blendxapi/discovery/checkout/` | Check out for the signed-in learner. | Client secret and learner session |

## Related checkout and enrollment APIs

| Method | Endpoint | Purpose | Identity |
| --- | --- | --- | --- |
| `POST` | `/blendxapi/payment/checkout/` | Process the signed-in learner’s existing server-side cart. | Learner session and `orgName` |
| `GET` | `/blendxapi/payment/capabilities/` | Inspect the organisation’s payment capabilities. | Learner session and `orgName` |
| `POST` | `/blendxapi/enrollments/client/enroll/` | Grant course access by learner email. | Client secret |
| `POST` | `/blendxapi/enrollments/client/unenroll/` | Remove or cancel course access by learner email. | Client secret |

Platform administration, deployment, internal triggers, and payment webhooks are operated by Blend-ed and are intentionally outside this client guide.

## Data guides
- [Courses](/blendx-discovery/courses/) documents list and detail fields,
outlines, effort, and enrollment checks.
- [Programs](/blendx-discovery/programs/) documents program list and detail
payloads and tag discovery.
- [Organisations](/blendx-discovery/organisations/) documents organisation
identity, branding, and marketing metadata.
- [Checkout](/blendx-discovery/checkout/) and [Enrollment](/blendx-discovery/enrollment/) document request and response
flows for commerce integrations.