Skip to main content

Get Header Link

Get one header link on a course. The link is the unpublished one, or the live link when nothing is unpublished. The response has no preview_url. See Header Link Object.

Request​

GET /players/{playerId}/header-links/{id}

Path Parameters​

ParameterTypeRequiredDescription
playerIdstringYesCourse UUID. See Identifiers.
idstringYesHeader link UUID

Example Request​

curl -X GET "https://app.easy.tools/api/v1/players/8f3c1a62-d047-4e89-9b25-1c6a4d8e0f71/header-links/4b8e1c70-5d29-4a16-8f33-0c7a2e9d4b51" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Response​

Success Response (200)​

{
  "data": {
    "id": "4b8e1c70-5d29-4a16-8f33-0c7a2e9d4b51",
    "name": "Syllabus",
    "link_url": "https://mysite.com/syllabus",
    "type": "link",
    "side": "left",
    "order": 0
  }
}

Response Fields​

See Header Link 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.