🗃️Endpoints - Groups

List group members

List Group members

get

/v1/groups/{groupId}/spotMembers

Path parameters

groupIdstringrequired

The id of the group

Query parameters

pagenullable integer

The page number in a paginated set of results

limitnullable integer

The limit of results to be returned per page

email[in]string[]

The emails of spot member to include in the result

firstname[in]string[]

The firstnames of spot member to include in the result

lastname[in]string[]

The lastnames of spot member to include in the result

role[in]enum[]

The roles of spot member to include in the result

registrationDate[before]integer

Spot members where registration date is before a specific date (Unix timestamp format)

registrationDate[after]integer

Spot members where registration date is after a specific date (Unix timestamp format)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers'

200

400

200

{
  "items": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "customRoleId": "text",
      "status": "Accepted",
      "firstname": "text",
      "lastname": "text",
      "warnings": 1,
      "embedBaseUrls": {
        "default": "text",
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "total": 1
}

Group members returned successfully

Add member to a group

Add member to a group

post

/v1/groups/{groupId}/spotMembers

Path parameters

groupIdstringrequired

The id of the group

Body

spotMemberIdstringrequired

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

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberId":"text"}'

204

400

404

204

No body

Member successfully added

Create a group

Create a group

post

/v1/groups

Body

namestringrequired

The name of the group

descriptionstring

The description of the group

emojistring

The emoji of the group

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/groups' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

201

400

201

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

Group has been successfully created

List groups

List groups

get

/v1/groups

Query parameters

pagenullable integer

The page number in a paginated set of results

limitnullable integer

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/groups'

200

400

200

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

Groups returned successfully

Delete a group

Delete a group

delete

/v1/groups/{groupId}

Path parameters

groupIdstringrequired

The id of the group

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}'

204

400

404

204

No body

Group successfully deleted

Update a group

Update a group

put

/v1/groups/{groupId}

Path parameters

groupIdstringrequired

The id of the group

Body

namestring

The name of the group

descriptionnullable string

The description of the group

emojinullable string

The emoji of the group

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}' \
  --header 'Content-Type: application/json'

200

400

404

200

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

Group successfully updated

Get a group

Get a group

get

/v1/groups/{groupId}

Path parameters

groupIdstringrequired

The id of the group

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}'

200

400

404

200

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

Group found and returned successfully

Add multiple members to a group

Add members to a group

post

/v1/groups/{groupId}/spotMembers~bulkAdd

Path parameters

groupIdstringrequired

The id of the group

Body

spotMemberIdsstring[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers~bulkAdd' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberIds":[null]}'

200

400

404

200

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

Members successfully added

Remove multiple members from a group

Remove members from a group

post

/v1/groups/{groupId}/spotMembers~bulkRemove

Path parameters

groupIdstringrequired

ID of the group

Body

spotMemberIdsstring[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/groups/{groupId}/spotMembers~bulkRemove' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberIds":[null]}'

200

400

404

200

{
  "removedSpotMembersCount": 1
}

Members successfully removed

Create multiple groups

Create multiple groups

post

/v1/groups~bulkCreate

Body

namestringrequired

The name of the group

descriptionstring

The description of the group

emojistring

The emoji of the group

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/groups~bulkCreate' \
  --header 'Content-Type: application/json' \
  --data '[{"name":"text"}]'

201

400

413

201

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

Groups has been successfully created