🗃️Endpoints - Groups

List group members

get

List Group members

Paramètres de chemin

groupIdstringRequis

The id of the group

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

email[in]string[]Optionnel

The emails of spot member to include in the result

firstname[in]string[]Optionnel

The firstnames of spot member to include in the result

lastname[in]string[]Optionnel

The lastnames of spot member to include in the result

registrationDate[before]integerOptionnel

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

registrationDate[after]integerOptionnel

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

Réponses

200

Group members returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/groups/{groupId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

{
  "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
}

Add member to a group

post

Add member to a group

Paramètres de chemin

groupIdstringRequis

The id of the group

Corps

spotMemberIdstringRequis

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

Réponses

204

Member successfully added

400

Malformed payload

404

Group not found

post

HTTPcURLJavaScriptPython

POST /v1/groups/{groupId}/spotMembers HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "spotMemberId": "text"
}

Aucun contenu

Create a group

post

Create a group

Corps

namestringRequis

The name of the group

descriptionstringOptionnel

The description of the group

emojistringOptionnel

The emoji of the group

Réponses

201

Group has been successfully created

application/json

400

Malformed payload

post

HTTPcURLJavaScriptPython

POST /v1/groups HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 51

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

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

List groups

get

List groups

Paramètres de requête

pageinteger | nullableOptionnel

The page number in a paginated set of results

limitinteger | nullableOptionnel

The limit of results to be returned per page

name[eq]stringOptionnel

Get a group by a specific name

name[contains]stringOptionnel

Get a group that contains this name

Réponses

200

Groups returned successfully

application/json

400

Malformed payload

get

HTTPcURLJavaScriptPython

GET /v1/groups HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Delete a group

delete

Delete a group

Paramètres de chemin

groupIdstringRequis

The id of the group

Réponses

204

Group successfully deleted

400

Malformed payload

404

Group not found

delete

HTTPcURLJavaScriptPython

DELETE /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

Aucun contenu

Update a group

put

Update a group

Paramètres de chemin

groupIdstringRequis

The id of the group

Corps

namestringOptionnel

The name of the group

descriptionstring | nullableOptionnel

The description of the group

emojistring | nullableOptionnel

The emoji of the group

Réponses

200

Group successfully updated

application/json

400

Malformed payload

404

Group not found

put

HTTPcURLJavaScriptPython

PUT /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 51

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

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

Get a group

get

Get a group

Paramètres de chemin

groupIdstringRequis

The id of the group

Réponses

200

Group found and returned successfully

application/json

400

Malformed payload

404

Group not found

get

HTTPcURLJavaScriptPython

GET /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*

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

Add multiple members to a group

post

Add members to a group

Paramètres de chemin

groupIdstringRequis

The id of the group

Corps

spotMemberIdsstring[]Requis

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

Réponses

200

Members successfully added

application/json

400

Malformed payload

404

Group not found

post

HTTPcURLJavaScriptPython

POST /v1/groups/{groupId}/spotMembers~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

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

Remove multiple members from a group

post

Remove members from a group

Paramètres de chemin

groupIdstringRequis

ID of the group

Corps

spotMemberIdsstring[]Requis

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

Réponses

200

Members successfully removed

application/json

400

Malformed payload

404

Group not found

post

HTTPcURLJavaScriptPython

POST /v1/groups/{groupId}/spotMembers~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "spotMemberIds": [
    "text"
  ]
}

{
  "removedSpotMembersCount": 1
}

Create multiple groups

post

Create multiple groups

Corps

namestringRequis

The name of the group

descriptionstringOptionnel

The description of the group

emojistringOptionnel

The emoji of the group

Réponses

201

Groups has been successfully created

application/json

400

Malformed payload

413

Payload is too large

post

HTTPcURLJavaScriptPython

POST /v1/groups~bulkCreate HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 53

[
  {
    "name": "text",
    "description": "text",
    "emoji": "text"
  }
]

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