API

List groups

GET /v1/groups

List groups

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

    Get a group by a specific name

  • name[contains] string

    Get a group that contains this name

Responses

  • 200 application/json

    Groups 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 group.

      • name string Required

        The name of the group.

      • description string

        The description of the group

      • emoji string

        The emoji of the group

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

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