Documentation

Admin - Units

Get unit details

Returns unit details with content statistics and content list.

ProductionStagingUAT
GEThttps://ankiren.com/api/admin/courses/{courseId}/units/{unitId}

Parameters

Path Parameters

  • courseIdintegerpathRequired

    Course ID

  • unitIdintegerpathRequired

    Unit ID

Responses

200 · Unit details

  • idinteger
  • courseIdinteger
  • externalIdstring?
  • titlestring
  • descriptionstring?
  • sortOrderinteger
  • imageUrlstring<uri>?
    format: uri
  • status"draft" | "published" | "archived"
  • createdAtstring<date-time>
    format: date-time
  • updatedAtstring<date-time>
    format: date-time
  • contentCountinteger
  • videoCountinteger
  • pdfCountinteger
  • quizCountinteger
  • contents[CourseContent]
    • idinteger
    • unitIdinteger
    • externalIdstring?
    • namestring
    • type1 | 2 | 3 | …

      Content type:

      • 1: Video
      • 2: PDF
      • 3: Quiz (Multiple Choice)
      • 6: Quiz (Matching)
      • 8: Quiz (Dropdown)
      • 9: Quiz (True/False)
      • 11: Quiz (Image)
      • 12: Quiz (Mixed)
      enum: 1, 2, 3, 6, 8, 9, 11, 12
    • lessonstring?

      HTML content for the lesson

    • sortOrderinteger
    • videoUrlstring<uri>?
      format: uri
    • pdfUrlstring<uri>?
      format: uri
    • totalScoreinteger
      default: 0
    • status"draft" | "published" | "archived"
    • createdAtstring<date-time>
      format: date-time
    • updatedAtstring<date-time>
      format: date-time
application/json
{
  "id": 1,
  "courseId": 1,
  "externalId": "unit-hiragana-01",
  "title": "Hiragana Basics",
  "description": "Learn the basic hiragana characters",
  "sortOrder": 0,
  "imageUrl": "https://ankiren.com",
  "status": "published",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "contentCount": 5,
  "videoCount": 2,
  "pdfCount": 1,
  "quizCount": 2,
  "contents": [
    {
      "id": 1,
      "unitId": 1,
      "externalId": "content-hiragana-intro",
      "name": "Introduction to Hiragana",
      "type": 1,
      "lesson": "string",
      "sortOrder": 0,
      "videoUrl": "https://example.com/videos/hiragana-intro.mp4",
      "pdfUrl": "https://example.com/pdfs/hiragana-guide.pdf",
      "totalScore": 100,
      "status": "published",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Sample Code

Đổi ngôn ngữ ở ô Language trên thanh Documentation.

cURL
curl -X GET 'https://ankiren.com/api/admin/courses/{courseId}/units/{unitId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'