openedx / openedx/openedx-platform
[API] Certificates
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Functional Area: Certificates
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Course Management | v1 | /contentstore/v1/certificates/{course_id} |
GET | Retrieves all certificates associated with a course, including certificate_activation_handler_url, certificate_web_view_url, certificates array with details (course_title, description, signatories, is_active, etc.), course_modes, and other metadata. Useful for AI tools performing automated certificate verification, reporting, or analytics. |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Course Management v1 certificates endpoint at /contentstore/v1/certificates/{course_id} and review how this functional area is represented in the project. Done should document the GET response and its certificate metadata, including activation and web-view URLs, certificate details, course modes, and related fields.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100