Get a spot

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://help-api.meltingspot.io/mcp

Standard setup for AI tools providing an mcp.json file

{
  "API MCP server": {
    "url": "https://help-api.meltingspot.io/mcp"
  }
}

GET /v1/spots/{spotId}

Get a spot

Path parameters

spotId string Required

The id of the spot

Responses

200 application/json

The spot has been successfully returned.
Hide response attributes Show response attributes object
- id string Required
  
  The id of the spot.
- name string Required
  
  The name of the spot.
- description string Required
  
  The description of the spot.
- privacy string Required
  
  The privacy of the spot.
  
  Values are Public or Private.
- ownerId string Required
  
  The ownerId of the spot. Corresponds to the userId of the user who created the spot.
- lang string Required
  
  The language of the spot.
  
  Values are en, fr, de, it, es, pt, or nl.
- theme object Required
  
  The theme of the spot. Null when the spot has no theme.
  
  Hide theme attributes Show theme attributes object
  
  fonts object Required
  
  Fonts of the theme.
  
  Hide fonts attribute Show fonts attribute object
  
  default string | null Required
  
  Default font of the theme.
  
  Values are Archivo, Barlow, BodoniModa, BricolageGrotesque, DMSans, FiraSans, Fraunces, Fredoka, GillSans, InclusiveSans, Inter, Lato, Lora, Manrope, Merriweather, Montserrat, Noto, NunitoSans, OpenSans, Poppins, Raleway, Roboto, Rubik, SourceSans, SpaceGrotesk, Syne, Ubuntu, Urbanist, VarelaRound, or WorkSans.
  
  palettes object Required
  
  Palettes of the theme.
  
  Hide palettes attributes Show palettes attributes object
  
  light object Required
  
  Colors of the theme in light mode.
  
  Hide light attributes Show light attributes object
  
  primary object | null Required
  
  Background color in hex format (#FFFFFF).
  
  primaryText object | null Required
  
  Primary text color in hex format (#FFFFFF).
  
  secondary object | null Required
  
  Secondary color in hex format (#FFFFFF).
  
  secondaryText object | null Required
  
  Secondary text color in hex format (#FFFFFF).
  
  link object | null Required
  
  Link color in hex format (#FFFFFF).
  
  dark object Required
  
  Colors of the theme in dark mode.
  
  Hide dark attributes Show dark attributes object
  
  primary object | null Required
  
  Background color in hex format (#FFFFFF).
  
  primaryText object | null Required
  
  Primary text color in hex format (#FFFFFF).
  
  secondary object | null Required
  
  Secondary color in hex format (#FFFFFF).
  
  secondaryText object | null Required
  
  Secondary text color in hex format (#FFFFFF).
  
  link object | null Required
  
  Link color in hex format (#FFFFFF).
- modules array[object] Required
  
  The modules of the spot, sorted by order.
  
  Hide modules attributes Show modules attributes object
  
  type string Required
  
  The type of the module. It designates the module in the spotModuleConfigs of PUT /spots/:spotId.
  
  Values are SpotHomePage, LearningPaths, Lives, Courses, Roleplays, Channels, Collections, or MemberDirectory.
  
  enabled boolean Required
  
  Whether the module is enabled.
  
  order number Required
  
  The position of the module in the menu, starting at 0.
401

Unauthorized
403

Forbidden
404

Spot not found

GET /v1/spots/{spotId}

curl \
 --request GET 'https://openapi.meltingspot.io/v1/spots/{spotId}'

Response examples (200)

{
  "id": "string",
  "name": "string",
  "description": "string",
  "privacy": "Public",
  "ownerId": "string",
  "lang": "en",
  "theme": {
    "fonts": {
      "default": "Archivo"
    },
    "palettes": {
      "light": {
        "primary": {},
        "primaryText": {},
        "secondary": {},
        "secondaryText": {},
        "link": {}
      },
      "dark": {
        "primary": {},
        "primaryText": {},
        "secondary": {},
        "secondaryText": {},
        "link": {}
      }
    }
  },
  "modules": [
    {
      "type": "SpotHomePage",
      "enabled": true,
      "order": 42.0
    }
  ]
}