---
title: "Get a mission by ID"
method: GET
path: "/api/v1/missions/{missionId}"
tags: ["cms"]
---

# Get a mission by ID

`GET /api/v1/missions/{missionId}`

## Path parameters

- `missionId` string, required

## Query parameters

- `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'pl' | 'zh' | 'ja' | 'id' | 'tr' | 'pt' | 'el' | 'ko' | 'vi' | 'hi' | 'ms' | 'th' | 'hr' | 'ro' | 'bg' | 'sv' | 'no' | 'yue'

## Response `201`

- MissionResponseDTO
  - `additional_material` union[], nullable — Additional materials attached to the mission
    - union
      - object
        - `relationTo` 'client-documents', required
        - `value` union, required
          - string — Document ID
          - object
            - `createdAt` string, required — Creation timestamp
            - `description` string, nullable — Optional description of the document
            - `filename` string, nullable — Original filename of the document
            - `filesize` number, nullable — File size in bytes
            - `height` number, nullable — Image height in pixels (if applicable)
            - `id` string, required — Unique identifier for the client document
            - `mimeType` string, nullable — MIME type of the document
            - `signedUrl` string, nullable — Signed URL for secure document access
            - `title` string, required — Title of the document
            - `updatedAt` string, required — Last update timestamp
            - `url` string, nullable — Public URL to access the document
            - `width` number, nullable — Image width in pixels (if applicable)
      - object
        - `relationTo` 'external-links', required
        - `value` union, required
          - string — External link ID
          - object
            - `createdAt` string, required — Creation timestamp
            - `description` string, nullable — Optional description of the external link
            - `id` string, required — Unique identifier for the external link
            - `title` string, required — Title of the external link
            - `updatedAt` string, required — Last update timestamp
            - `url` string, required — URL of the external resource
      - object
        - `relationTo` 'text-snippets', required
        - `value` union, required
          - string — Text snippet ID
          - object
            - `createdAt` string, required — Creation timestamp
            - `description` string, required — Content of the text snippet
            - `id` string, required — Unique identifier for the text snippet
            - `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans', required — Language of the text snippet
            - `title` string, required — Title of the text snippet
            - `updatedAt` string, required — Last update timestamp
  - `createdAt` string, required — Creation timestamp
  - `difficulty` string, required — Difficulty level of the mission
  - `hide_examples` boolean, nullable — Whether learners should not see desired behaviour examples for this mission.
  - `hide_scorecard` boolean, nullable — Whether learners should not see the mission scorecard.
  - `id` string, required — Unique identifier for the mission
  - `language` 'en' | 'de' | 'fr' | 'es' | 'it' | 'nl' | 'zh-Hans', required
  - `persona` object, required — Persona assigned to this mission
    - `avatar_file` object, required — Avatar image for the persona
      - `createdAt` string, required — Creation timestamp
      - `filename` string, required — Original filename of the avatar
      - `filesize` number, required — File size in bytes
      - `height` number, required — Image height in pixels
      - `id` string, required — Unique identifier for the avatar file
      - `mimeType` string, required — MIME type of the avatar file
      - `sizes` object, required — Available size variants for the avatar
        - `card` object — Card size preview URL
          - `url` string — Preview URL for the image
        - `thumbnail` object — Thumbnail size preview URL
          - `url` string — Preview URL for the image
      - `updatedAt` string, required — Last update timestamp
      - `url` string, required — Public URL to access the avatar
      - `width` number, required — Image width in pixels
    - `createdAt` string, required — Creation timestamp
    - `description` string, nullable — Optional description of the persona
    - `name` string, required — Full name of the persona
    - `role` string, required — The role the persona plays in the conversation. For B2B sales conversations, use their job title or function. If there is no workplace, use their relationship to the conversation, such as "Prospective buyer," "Existing customer," or "Private customer." For role-plays about manager skills, use their relationship to the learner, such as "Team member." This is shown to the learner and used to instruct the AI during the role-play.
    - `updatedAt` string, required — Last update timestamp
    - `workplace_description` string — Optional description of the workplace
    - `workplace_name` string — Name of the workplace where the persona works. Empty when no workplace is relevant.
  - `saga` object, required — Saga that contains this mission
    - `id` string, required — Unique identifier for the saga
    - `name` string, required — Name of the saga
  - `scenario` object, required — Scenario details for the mission
    - `description` string, required — Detailed description of the scenario
    - `duration` number, required — Expected duration in minutes
    - `goal` string, required — Primary goal or objective of the scenario
    - `tag` string — Optional tag for categorizing the scenario
  - `scorecard` object, required — Scorecard for evaluating the mission
    - `id` string, required — Unique identifier for the scorecard
    - `items` object[], required — List of scorecard evaluation items
      - `desired_behaviours` object[], nullable — Array of desired behaviors for this item
        - `behaviour` string, required — Description of the desired behavior
        - `examples` string, nullable — List of examples demonstrating the behavior
      - `desired_outcome` string, nullable — Goal or objective for this specific item
      - `id` string, required — Unique identifier for the scorecard item
      - `item_title` string — Optional title for the scorecard item
    - `title` string, required — Title of the scorecard
  - `title` string, required — Title of the mission
  - `updatedAt` string, required — Last update timestamp

---

[API](https://skmtc.net/wejam/apis/jam.md) · [All operations](https://skmtc.net/wejam/apis/jam/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wejam/jam/revisions/bd5a5f406bca/schema)
