---
title: "GET /api/dashboard"
method: GET
path: "/api/dashboard"
tags: ["Dashboard"]
---

# GET /api/dashboard

`GET /api/dashboard`

## Request

- Base URL: `https://api.wearelearning.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wearelearning.io/api/dashboard`
- Auth: OAuth 2
  - Implicit: `https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io`

## Response `200`

OK

- DashboardDto
  - `simulations` DashboardSimulationDto[], required
    - `id` string, required
    - `title` string, required
    - `createdAt` string, date-time, required
    - `createdBy` string, required
    - `deletedAt` string, date-time, nullable
    - `status` 'Draft' | 'Published', required
    - `scene` SceneDto
      - `id` string, required
      - `guid` string, required
      - `name` string, required
      - `timeOfDay` number, float, required
      - `indoorLighting` ColorDto, required
        - `r` number, float, nullable
        - `g` number, float, nullable
        - `b` number, float, nullable
        - `brightness` number, float, nullable
      - `ambientSound` string, required
      - `ambienceVolume` number, float, required
      - `background` BackgroundDto, required
        - `originalImageUrl` string, required
        - `thumbnailImageUrl` string, nullable
        - `desktopImageUrl` string, nullable
        - `mobileImageUrl` string, nullable
        - `mediaReference` MediaReferenceDto, required
          - `id` string, required
          - `fileName` string, required
          - `extension` string, required
          - `contentType` string, required
          - `url` string, required
          - `publicUrl` string, required
          - `thumbnailUrl` string, required
          - `createdAt` string, date-time, required
          - `updatedAt` string, date-time, required
          - `metadata` MetadataDto, required
            - `type` 'Image' | 'ImageVersion' | 'Video' | 'Audio' | 'Document', required
            - `size` integer, nullable
          - `folderId` string, uuid, nullable: A valid GUID
        - `margin` MarginDto, required
          - `top` number, float, nullable
          - `right` number, float, nullable
          - `bottom` number, float, nullable
          - `left` number, float, nullable
      - `image` string, required
      - `sceneBackground` string, required
      - `sceneCrop` MarginDto, required
        - `top` number, float, nullable
        - `right` number, float, nullable
        - `bottom` number, float, nullable
        - `left` number, float, nullable
      - `title` string, required
      - `characters` SceneCharacterDto[], required
        - `placeholder` string, required
        - `position` Position2dDto, required
          - `x` number, double, required
          - `y` number, double, required
        - `voice` string, required
      - `characterSpots` integer, required
      - `tags` string[], required
      - `hidden` boolean, nullable
      - `isDeleted` boolean, nullable
      - `locked` boolean, nullable
      - `global` boolean, nullable
    - `characters` DashboardSimulationCharacterDto[], required
      - `id` string, required
      - `name` string, required
      - `image` string, required
      - `gender` 'Female' | 'Male', required
      - `isChild` boolean, required
      - `icon` string, required
      - `isGlobal` boolean, required
      - `voiceInfo` VoiceDto, required
        - `displayName` string, required
        - `shortName` string, required
        - `locale` string, required
        - `gender` 'Female' | 'Male', required
        - `sampleAudioUrl` string, required
        - `wordsPerMinute` integer, required
        - `speakingStyles` SpeakingStyle[], required
          - `value` string, required
          - `displayName` string, required
          - `iconUrl` string, required
        - `provider` 'AzureCognitiveServices' | 'ElevenLabs', required
        - `supportsAudioTags` boolean, required
        - `fileFormat` 'Wav' | 'Aac' | 'Mp3', required
    - `description` string, required
    - `publicId` string, required
    - `languageCode` string, required
    - `gradient` string, required
    - `protection` SimulationProtection
      - `domains` string[], required
      - `password` string, required
      - `type` 'None' | 'Domain' | 'Password'
    - `sharedViaIntegration` 'None' | 'Motimate' | 'CustomExperienceApi' | 'LearningCenter'
    - `plays` integer, nullable
    - `completions` integer, nullable
    - `lockInfo` SimulationLockDto
      - `locked` boolean, required
      - `lockedBy` string, nullable
      - `reason` LockReasonDto
        - `reason` 'Editing' | 'InTranslation'
        - `description` string, nullable
    - `folderLockInfo` FolderLockDto
      - `locked` boolean, required
      - `inherited` boolean, required
      - `lockedBy` string, required
      - `lockedFolderId` string, uuid, required: A valid GUID
      - `lockedFolderName` string, required
      - `canBypass` boolean, required
    - `voiceover` VoiceOverDto, required
      - `enabled` boolean, required
      - `selectedVoiceName` string, required
      - `gender` 'Female' | 'Male', required
      - `voiceInfo` VoiceDto
        - `displayName` string, required
        - `shortName` string, required
        - `locale` string, required
        - `gender` 'Female' | 'Male', required
        - `sampleAudioUrl` string, required
        - `wordsPerMinute` integer, required
        - `speakingStyles` SpeakingStyle[], required
          - `value` string, required
          - `displayName` string, required
          - `iconUrl` string, required
        - `provider` 'AzureCognitiveServices' | 'ElevenLabs', required
        - `supportsAudioTags` boolean, required
        - `fileFormat` 'Wav' | 'Aac' | 'Mp3', required
    - `playSettings` SimulationPlaySettingsDto
      - `playMobileInBrowser` boolean, required
      - `hideCaptions` boolean, required
      - `allowNavigation` boolean, required
      - `allowForwardNavigationSkip` boolean, required
      - `defaultInputMode` 'Speaking' | 'Typing', required
    - `themeId` string, nullable
  - `characters` CharacterDto[], required
    - `id` string, required
    - `name` string, required
    - `image` string, required
    - `icon` string, required
    - `gender` 'Female' | 'Male', required
    - `isChild` boolean, required
    - `eyeColor` ColorDto, required
      - `r` number, float, nullable
      - `g` number, float, nullable
      - `b` number, float, nullable
      - `brightness` number, float, nullable
    - `skinColor` ColorDto, required
      - `r` number, float, nullable
      - `g` number, float, nullable
      - `b` number, float, nullable
      - `brightness` number, float, nullable
    - `customSkinTexture` string, uuid, nullable: A valid GUID
    - `blendShape` BlendShapeDto[], required
      - `path` string, nullable
      - `property` string, required
      - `value` number, float, required
    - `clothing` ClothingDto[], required
      - `guid` string, required
      - `materials` MaterialDto[], required
        - `texture` integer, required
        - `color` ColorDto, required
          - `r` number, float, nullable
          - `g` number, float, nullable
          - `b` number, float, nullable
          - `brightness` number, float, nullable
        - `customTextureGuid` string, uuid, nullable: A valid GUID
        - `textureGuid` string, uuid, nullable: A valid GUID
        - `materialPath` string, nullable
        - `customTextureUV` integer, nullable
      - `variant` integer, required
      - `materialOverrides` MaterialOverrideDto[], required
        - `id` string, uuid, required: A valid GUID
        - `renderer` string, required
        - `materialIndex` string, required
      - `serializedMaterials` SerializedMaterialDto[], required
        - `id` string, uuid, required: A valid GUID
        - `materialName` string, required
        - `shaderName` string, required
        - `renderQueue` integer, nullable
        - `keywords` string[], nullable
        - `properties` PropertyDto[], nullable
          - `key` string, required
          - `value` PropertyValueDto, required
            - `type` 'Int' | 'Float' | 'Bool' | 'Range' | 'Color' | 'Vector4' | 'Vector3' | 'Vector2' | 'Texture', required
    - `skinTexture` integer, nullable
    - `isGlobal` boolean, required
    - `skinTextureGuid` string, uuid, nullable: A valid GUID
    - `browDescriptor` BrowDescriptorDto
      - `browColor` ColorDto
        - `r` number, float, nullable
        - `g` number, float, nullable
        - `b` number, float, nullable
        - `brightness` number, float, nullable
      - `browTextureGuid` string, uuid, nullable: A valid GUID
    - `folderPath` string, nullable
    - `isOneModel` boolean, required
    - `materialOverrides` MaterialOverrideDto[], required
      - `id` string, uuid, required: A valid GUID
      - `renderer` string, required
      - `materialIndex` string, required
    - `serializedMaterials` SerializedMaterialDto[], required
      - `id` string, uuid, required: A valid GUID
      - `materialName` string, required
      - `shaderName` string, required
      - `renderQueue` integer, nullable
      - `keywords` string[], nullable
      - `properties` PropertyDto[], nullable
        - `key` string, required
        - `value` PropertyValueDto, required
          - `type` 'Int' | 'Float' | 'Bool' | 'Range' | 'Color' | 'Vector4' | 'Vector3' | 'Vector2' | 'Texture', required
    - `definitionId` string, uuid, nullable: A valid GUID
  - `scenes` SceneDto[], required
    - `id` string, required
    - `guid` string, required
    - `name` string, required
    - `timeOfDay` number, float, required
    - `indoorLighting` ColorDto, required
      - `r` number, float, nullable
      - `g` number, float, nullable
      - `b` number, float, nullable
      - `brightness` number, float, nullable
    - `ambientSound` string, required
    - `ambienceVolume` number, float, required
    - `background` BackgroundDto, required
      - `originalImageUrl` string, required
      - `thumbnailImageUrl` string, nullable
      - `desktopImageUrl` string, nullable
      - `mobileImageUrl` string, nullable
      - `mediaReference` MediaReferenceDto, required
        - `id` string, required
        - `fileName` string, required
        - `extension` string, required
        - `contentType` string, required
        - `url` string, required
        - `publicUrl` string, required
        - `thumbnailUrl` string, required
        - `createdAt` string, date-time, required
        - `updatedAt` string, date-time, required
        - `metadata` MetadataDto, required
          - `type` 'Image' | 'ImageVersion' | 'Video' | 'Audio' | 'Document', required
          - `size` integer, nullable
        - `folderId` string, uuid, nullable: A valid GUID
      - `margin` MarginDto, required
        - `top` number, float, nullable
        - `right` number, float, nullable
        - `bottom` number, float, nullable
        - `left` number, float, nullable
    - `image` string, required
    - `sceneBackground` string, required
    - `sceneCrop` MarginDto, required
      - `top` number, float, nullable
      - `right` number, float, nullable
      - `bottom` number, float, nullable
      - `left` number, float, nullable
    - `title` string, required
    - `characters` SceneCharacterDto[], required
      - `placeholder` string, required
      - `position` Position2dDto, required
        - `x` number, double, required
        - `y` number, double, required
      - `voice` string, required
    - `characterSpots` integer, required
    - `tags` string[], required
    - `hidden` boolean, nullable
    - `isDeleted` boolean, nullable
    - `locked` boolean, nullable
    - `global` boolean, nullable
  - `storiesFolders` BasicFolderDto[], nullable
    - `id` string, uuid, required: A valid GUID
    - `name` string, required
    - `lockInfo` FolderLockDto
      - `locked` boolean, required
      - `inherited` boolean, required
      - `lockedBy` string, required
      - `lockedFolderId` string, uuid, required: A valid GUID
      - `lockedFolderName` string, required
      - `canBypass` boolean, required

---

[API](https://skmtc.dev/wearelearning/apis/we-are-learning-api.md) - [All operations](https://skmtc.dev/wearelearning/apis/we-are-learning-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wearelearning/apis/we-are-learning-api/revisions/e2ca5265db77?raw)