Skip to main content

Get Certificate

Get the certificate template for a course. The template is the unpublished one, or the live template when nothing is unpublished. The response has no preview_url. When no template has been saved, the response is the starting values and this call does not store a template. See Certificate Object.

Request​

GET /players/{id}/certificate

Path Parameters​

ParameterTypeRequiredDescription
idstringYesCourse UUID. See Identifiers.

Example Request​

curl -X GET "https://app.easy.tools/api/v1/players/8f3c1a62-d047-4e89-9b25-1c6a4d8e0f71/certificate" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Response​

Success Response (200)​

Starting values, before any update:

{
  "data": {
    "is_active": null,
    "progress_threshold_percent": 80,
    "available_from": null,
    "template": "light-image",
    "content": {
      "course_name": null,
      "course_description": null,
      "course_image_url": null,
      "background_image_url": null,
      "color": null,
      "text_color": null
    }
  }
}

Response Fields​

See Certificate Object.

Error Responses​

Not Found Error (404)​

See Identifiers.

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  }
}

Authentication, permission, and rate-limit errors are described in Authorization.