🗃️Endpoints - Groups
List group members
List Group members
The id of the group
The page number in a paginated set of results
The limit of results to be returned per page
The emails of spot member to include in the result
The firstnames of spot member to include in the result
The lastnames of spot member to include in the result
Spot members where registration date is before a specific date (Unix timestamp format)
Spot members where registration date is after a specific date (Unix timestamp format)
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
Add member to a group
The id of the group
An uuid representing the unique identifier of the spot member to add to the group
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
Create a group
The name of the group
The description of the group
The emoji of the group
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
List groups
The page number in a paginated set of results
The limit of results to be returned per page
Get a group by a specific name
Get a group that contains this name
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 a group
The id of the group
DELETE /v1/groups/{groupId} HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
Aucun contenu
Update a group
Update a group
The id of the group
The name of the group
The description of the group
The emoji of the group
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 a group
The id of the group
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
Add members to a group
The id of the group
An array of strings representing the unique identifiers of spot members to add to group
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
Remove members from a group
ID of the group
An array of strings representing the unique identifiers of spot members to remove from group
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
Create multiple groups
The name of the group
The description of the group
The emoji of the group
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"
}
]
}Dernière mise à jour
Cet article vous a-t-il été utile ?