API

List forums

GET /v1/forums

List forums

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

  • name[eq] string

    Search Forum with a specified name

  • name[contains] string

    Search Forum that contains this value in his name

Responses

  • 200 application/json

    Forums returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items attributes object
      • id string Required

        The id of the forum.

      • name string Required

        The name of the forum.

      • emoji string

        The emoji of the forum

      • description string Required

        The description of the forum

      • createdAt integer Required

        Timestamp in ms of creation date

      • privacy string Required

        Privacy of the forum

        Values are Private or Secret.

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

GET /v1/forums 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/forums'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "emoji": "string",
      "description": "string",
      "createdAt": 42,
      "privacy": "Private"
    }
  ],
  "total": 42
}