Catalog API — Types
CompanyCatalog
A company's content catalog combining programs, assessments, and learning plans.
| Field | Type | Description |
|---|
companyId | ID! | The company ID this catalog belongs to |
programs | [CatalogProgram!]! | Programs available to this company |
assessments | [CatalogAssessment!]! | Assessments available to this company |
learningPlans | [CatalogLearningPlan!]! | Learning plans available to this company |
CatalogProgram
A program resource in the company catalog.
| Field | Type | Description |
|---|
key | String! | Unique program key |
version | Int! | Program version |
locale | String! | Program locale (e.g., en-us) |
type | ProgramType! | Program type |
title | String! | Program title |
summary | String! | Program summary/description |
syllabusUrl | String! | URL to the program syllabus |
imageUrl | String! | URL to the program image |
redirectUrl | String! | Redirect URL for the program |
duration | Duration! | Program duration (ISO 8601 format, e.g., P30D) |
modifiedDate | Time! | Date when the program was last modified |
ssoLaunchLinksByContract | [ContractLaunchLink!]! | SSO launch links by contract |
skillNames | [String!]! | Skill names associated with this program |
difficultyLevel | String | Difficulty level of this program (e.g., Beginner, Intermediate, Advanced). |
supportedLanguages | [String!] | Languages with approved translations for this program. Only present when translations are requested. |
translations | [ProgramTranslation!] | Translated metadata and approval info for each maintained language. Only present when translations are requested. |
ContractLaunchLink
SSO launch link for a specific contract.
| Field | Type | Description |
|---|
contractId | ID! | Contract ID |
launchUrl | String! | Launch URL for this contract |
ProgramTranslation
Translated metadata for a program in a specific language.
| Field | Type | Description |
|---|
language | String! | Language code (e.g., de, ja) |
title | String | Translated program title, if available |
summary | String | Translated program summary, if available |
version | String | Approved translation version (semver string, e.g., 2.0.1), if available |
major | Int | Major version of the approved translation |
minor | Int | Minor version of the approved translation |
patch | Int | Patch version of the approved translation |
skillNames | [String!] | Translated skill names, if available |
CatalogAssessment
An assessment resource in the company catalog.
| Field | Type | Description |
|---|
id | ID! | Assessment ID |
title | String! | Assessment title |
category | AssessmentCategory! | Assessment category |
passingScore | Float | Passing score (if applicable). Note: No standardized constraints exist on this value. Scores may represent percentages, decimal fractions, or point values, depending on the assessment configuration. |
isTimed | Boolean! | Whether the assessment is timed |
timeLimit | Duration | Time limit, if timed (ISO 8601 format, e.g., PT30M) |
totalQuestionsInAssessment | Int! | Total number of questions in the assessment |
CatalogLearningPlan
A learning plan in the company catalog.
| Field | Type | Description |
|---|
id | ID! | Learning plan ID |
title | String! | Learning plan title |
key | String! | Unique learning plan key |
slug | String! | URL-friendly slug for the learning plan |
steps | [CatalogLearningPlanStep!]! | Ordered steps in this learning plan |
CatalogLearningPlanStep
A step within a learning plan. An interface — use inline fragments to access type-specific fields (e.g. ... on CatalogProgramStep { programKey }).
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | The type of this step |
label | String! | Display label for this step |
CatalogProgramStep
Implements CatalogLearningPlanStep. A program step within a learning plan.
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | Step type (PROGRAM) |
label | String! | Display label |
programKey | String! | Program key identifying the program content |
CatalogAssessmentStep
Implements CatalogLearningPlanStep. An assessment step within a learning plan.
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | Step type (ASSESSMENT) |
label | String! | Display label |
assessmentId | ID! | Assessment ID identifying the assessment content |
CatalogContainerStep
Implements CatalogLearningPlanStep. A container step that groups child steps within a learning plan.
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | Step type (CONTAINER) |
label | String! | Display label |
children | [CatalogLearningPlanStep!]! | Child steps within this container |
CatalogApplicationStep
Implements CatalogLearningPlanStep. An application step within a learning plan.
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | Step type (APPLICATION) |
label | String! | Display label |
applicationId | ID! | Application ID identifying the application content |
CatalogSurveyStep
Implements CatalogLearningPlanStep. A survey step within a learning plan.
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | Step type (SURVEY) |
label | String! | Display label |
surveyId | ID! | Survey ID identifying the survey content |
CatalogWorkeraAssessmentStep
Implements CatalogLearningPlanStep. A Workera assessment step within a learning plan.
| Field | Type | Description |
|---|
stepId | ID! | Step ID |
stepType | LearningPlanStepType! | Step type (WORKERA_ASSESSMENT) |
label | String! | Display label |
domainId | ID! | Workera domain ID for this assessment |
Enums
ProgramType
| Value | Description |
|---|
COURSE | A course program |
DEGREE | A degree program |
PART | A part (section of a larger program) |
LearningPlanStepType
| Value | Description |
|---|
PROGRAM | A program step |
ASSESSMENT | An assessment step |
CONTAINER | A container grouping child steps |
APPLICATION | An application step |
SURVEY | A survey step |
WORKERA_ASSESSMENT | A Workera assessment step |
AssessmentCategory
| Value | Description |
|---|
PASS_FAIL | Graded assessment with pass/fail outcome |
PRACTICE | Practice assessment (no formal grading) |
Scalars
| Scalar | Description |
|---|
Time | Date and time formatted as an RFC 3339 string (e.g., 2025-06-15T10:00:00Z) |
Duration | Time interval following the ISO 8601 standard (e.g., P1Y2D, PT30M) |