🗃️Endpoints - Groups

List group members

List Group members

GEThttps://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers

Path parameters

groupId*string

The id of the group

Query parameters

Response

200400

Group members returned successfully

Body

application/json

items*array of SpotMemberApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 0
    }
  ]
}

Add member to a group

Add member to a group

POSThttps://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers

Path parameters

groupId*string

The id of the group

Body

application/json

spotMemberId*string

An uuid representing the unique identifier of the spot member to add to the group

Response

204400404

Member successfully added

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberId": "text"
    }),
});
const data = await response.json();

Create a group

Create a group

POSThttps://openapi.meltingspot.io/v1/groups

Body

application/json

name*string

The name of the group

descriptionstring

The description of the group

emojistring

The emoji of the group

Response

201400

Group has been successfully created

Body

application/json

id*string

The id of the group.

name*string

The name of the group.

descriptionstring

The description of the group

emojistring

The emoji of the group

iconstring

The icon of the group

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "icon": "text"
}

List groups

List groups

GEThttps://openapi.meltingspot.io/v1/groups

Query parameters

Response

200400

Groups returned successfully

Body

application/json

items*array of GroupApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ]
}

Delete a group

Delete a group

DELETEhttps://openapi.meltingspot.io/v1/groups/{groupId}

Path parameters

groupId*string

The id of the group

Response

204400404

Group successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Update a group

Update a group

PUThttps://openapi.meltingspot.io/v1/groups/{groupId}

Path parameters

groupId*string

The id of the group

Body

application/json

namestring

The name of the group

descriptionnullable string

The description of the group

emojinullable string

The emoji of the group

Response

200400404

Group successfully updated

Body

application/json

id*string

The id of the group.

name*string

The name of the group.

descriptionstring

The description of the group

emojistring

The emoji of the group

iconstring

The icon of the group

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "icon": "text"
}

Get a group

Get a group

GEThttps://openapi.meltingspot.io/v1/groups/{groupId}

Path parameters

groupId*string

The id of the group

Response

200400404

Group found and returned successfully

Body

application/json

id*string

The id of the group.

name*string

The name of the group.

descriptionstring

The description of the group

emojistring

The emoji of the group

iconstring

The icon of the group

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "description": "text",
  "emoji": "text",
  "icon": "text"
}

Add multiple members to a group

Add members to a group

POSThttps://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers~bulkAdd

Path parameters

groupId*string

The id of the group

Body

application/json

spotMemberIds*array of string

An array of strings representing the unique identifiers of spot members to add to group

Response

200400404

Members successfully added

Body

application/json

addedSpotMemberIds*array of string

The list of spot member id that were successfully added to the group.

failedSpotMemberIds*array of string

The list of spot member id that failed to be added to the group.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers~bulkAdd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "addedSpotMemberIds": [
    "text"
  ],
  "failedSpotMemberIds": [
    "text"
  ]
}

Remove multiple members from a group

Remove members from a group

POSThttps://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers~bulkRemove

Path parameters

groupId*string

ID of the group

Body

application/json

spotMemberIds*array of string

An array of strings representing the unique identifiers of spot members to remove from group

Response

200400404

Members successfully removed

Body

application/json

removedSpotMembersCount*integer

The number of members removed from the group.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers~bulkRemove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

{}

Create multiple groups

Create multiple groups

POSThttps://openapi.meltingspot.io/v1/groups~bulkCreate

Body

application/json

name*string

The name of the group

descriptionstring

The description of the group

emojistring

The emoji of the group

Response

201400413

Groups has been successfully created

Body

application/json

created*array of GroupApiResponse (object)

The groups that were created.

failed*array of CreateGroupApiBody (object)

The groups that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('https://openapi.meltingspot.io/v1/groups~bulkCreate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text"
      }
    ]),
});
const data = await response.json();

Response

201

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "emoji": "text",
      "icon": "text"
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text"
    }
  ]
}