CertificationTypeDetail

A request or response body; the type column links to the schemas it refers to.

CertificationTypeDetail

FieldTypeRequiredDescription
idstring (uuid)yes—
owner_organization_idstring (uuid)yes—
owner_department_idstring (uuid) | nullyes

Null when the organization itself owns the certification type.

subjectsarray of CertificationTypeSubjectyes

The subject matters whose records and evidence satisfy the rules, alphabetically; a record filed under any of them counts. Empty for a type proven by sign-offs, quizzes or external courses alone.

slugstringyes—
namestringyes—
descriptionstring | nullyes—
description_markdownstring | nullyes

Long-form narrative markdown below the summary line; never parsed.

awarding_modestringyes

automatic: the user claims the certification themselves once every rule is satisfied. approval: the user requests it and a permission holder decides.

one of "automatic" | "approval"

archived_atstring (date-time) | nullyes

When set, the record is retired; it stays readable but should not grow.

created_atstring (date-time)yes—
rulesarray of CertificationRuleyes

The proof rules of this type; all of them must be satisfied at once.

attachmentsarray of DescriptionAttachmentyes

The type's description attachments, in authored order — e.g. a blank form to fill and submit as evidence. The bytes are fetched through GET /certifications/{cert_id}/attachments/{attachment_id}/download.

jsonExample
{
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "owner_organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "subjects": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "slug": "string",
      "name": "string"
    }
  ],
  "slug": "string",
  "name": "string",
  "description": "string",
  "description_markdown": "string",
  "awarding_mode": "automatic",
  "archived_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "rules": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "certification_type_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "rule_kind": "subject_hours",
      "label": "string",
      "threshold_hours": 0,
      "threshold_count": 0,
      "evidence_type": "score",
      "quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "external_course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "scorm_course_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "job_aid_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "subject_matter_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "attachments": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "file_name": "string",
      "content_type": "string",
      "label": "string",
      "position": 0,
      "prefer_inline_display": true
    }
  ]
}