🗃️Endpoints - Les groupes

Lister les membres d'un groupe

get

List Group members

Path parameters

groupIdstringrequired

The id of the group

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

email[in]string[]optional

The emails of spot member to include in the result

firstname[in]string[]optional

The firstnames of spot member to include in the result

lastname[in]string[]optional

The lastnames of spot member to include in the result

role[in]string · enum[]optional

The roles of spot member to include in the result

registrationDate[before]integeroptional

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

registrationDate[after]integeroptional

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

Responses

application/json

objectoptional

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
}

Ajouter un membre à un groupe

post

Add member to a group

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

post

HTTPcURLJavaScriptPython

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

{
  "spotMemberId": "text"
}

No Content

Créer un groupe

post

Create a group

Body

namestringrequired

The name of the group

descriptionstringoptional

The description of the group

emojistringoptional

The emoji of the group

Responses

application/json

objectoptional

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

Lister les groupes du Spot

get

List groups

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

name[eq]stringoptional

Get a group by a specific name

name[contains]stringoptional

Get a group that contains this name

Responses

application/json

objectoptional

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
}

Supprimer un groupe

delete

Delete a group

Path parameters

groupIdstringrequired

The id of the group

Responses

delete

HTTPcURLJavaScriptPython

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

No Content

Modifier un groupe

put

Update a group

Path parameters

groupIdstringrequired

The id of the group

Body

namestringoptional

The name of the group

descriptionstring | nullableoptional

The description of the group

emojistring | nullableoptional

The emoji of the group

Responses

application/json

objectoptional

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

Récupérer un groupe

get

Get a group

Path parameters

groupIdstringrequired

The id of the group

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

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

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

Ajouter plusieurs membres à un groupe

post

Add members to a group

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

objectoptional

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

Supprimer plusieurs membres d'un groupe

post

Remove members from a group

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

objectoptional

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
}

Créer plusieurs groupes

post

Create multiple groups

Body

namestringrequired

The name of the group

descriptionstringoptional

The description of the group

emojistringoptional

The emoji of the group

Responses

application/json

objectoptional

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