🗃️Endpoints

All endpoints are divided into different sections:

• SpotMembers

• Lives

• Channels

• Forums

• Topics

• Search

• Groups

• Tags

• Notifications

SpotMembers

List Spot members

GET/v1/spotMembers

Query parameters

Response

200400

Spot 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('/v1/spotMembers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Invite a spot member

POST/v1/spotMembers

Body

application/json

email*string

The email of the spot member

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

201400

Spot member has been successfully invited

Body

application/json

id*string

The id of the spot member.

spotId*string

The id of the spot.

userId*nullable string

The id of the user.

email*string

The email of the spot member.

title*nullable string

The title of the spot member.

role*enum

The role of the spot member.

MemberAdmin

firstname*string

The firstname of the spot member.

lastname*string

The lastname of the spot member.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "firstname": "text",
  "lastname": "text"
}

Update a spot member

PUT/v1/spotMembers/{spotMemberId}

Path parameters

spotMemberId*string

The id of the spotMember

Body

application/json

firstnamestring

The first name of the spot member

lastnamestring

The last name of the spot member

titlestring

The title of the spot member

roleenum

The role of the spot member

MemberAdmin

statusenum

The status of the spot member

AcceptedRejectedDeactivated

avatarUrlnullable object

Response

200400404

Spot member successfully updated

Body

application/json

id*string

The id of the spot member.

spotId*string

The id of the spot.

userId*nullable string

The id of the user.

email*string

The email of the spot member.

title*nullable string

The title of the spot member.

role*enum

The role of the spot member.

MemberAdmin

firstname*string

The firstname of the spot member.

lastname*string

The lastname of the spot member.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "firstname": "text",
  "lastname": "text"
}

Get a spot member

GET/v1/spotMembers/{spotMemberId}

Path parameters

spotMemberId*string

The id of the spotMember

Response

200404

Spot member returned successfully

Body

application/json

id*string

The id of the spot member.

spotId*string

The id of the spot.

userId*nullable string

The id of the user.

email*string

The email of the spot member.

title*nullable string

The title of the spot member.

role*enum

The role of the spot member.

MemberAdmin

firstname*string

The firstname of the spot member.

lastname*string

The lastname of the spot member.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "spotId": "text",
  "userId": "text",
  "email": "text",
  "title": "text",
  "role": "Member",
  "firstname": "text",
  "lastname": "text"
}

Invite multiple spot members

POST/v1/spotMembers~bulkInvite

Body

application/json

emailsarray of string

The emails of members to invite

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

201400413

Spot members has been successfully invited

Body

application/json

created*array of SpotMemberApiResponse (object)

The spot members that were created.

failed*array of CreateSpotMemberApiBody (object)

The spot members that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "created": [
    {
      "id": "text",
      "spotId": "text",
      "userId": "text",
      "email": "text",
      "title": "text",
      "role": "Member",
      "firstname": "text",
      "lastname": "text"
    }
  ],
  "failed": [
    {
      "email": "text",
      "firstname": "text",
      "lastname": "text",
      "title": "text",
      "role": "Member",
      "avatarUrl": "text",
      "lang": "en",
      "theme": "light",
      "timezone": "Africa/Abidjan"
    }
  ]
}

Lives

List Lives

GET/v1/lives

Query parameters

Response

200400

Lives returned successfully

Body

application/json

items*array of LiveApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "title": "text",
      "startDate": "2024-09-08T01:02:09.276Z",
      "endDate": "2024-09-08T01:02:09.276Z",
      "metrics": {},
      "description": [
        "text"
      ],
      "status": "Ended",
      "computedStatus": "Ended",
      "solution": "Youtube",
      "privacy": {
        "visibility": "AnyOne",
        "participation": "AnySpotMembers"
      },
      "config": {
        "chatVisibility": "Display",
        "participantsVisibility": "Ended"
      },
      "builtInType": "Workshop",
      "createdAt": "2024-09-08T01:02:09.276Z",
      "spotId": "text",
      "builtInConfig": {
        "isRecorded": false,
        "recordAvailable": false,
        "videos": {
          "url": "text",
          "quality": "text",
          "encoding": "hls",
          "createdAt": "2024-09-08T01:02:09.276Z"
        }
      }
    }
  ]
}

Create a Live

POST/v1/lives

Body

application/json

title*string

The title of the Live

description*string

Description of the Live (in Markdown)

spotMemberHostId*string

The Spot member host of the Live

startDate*integer

Start date of the Live (Unix timestamp format)

endDate*integer

End date of the Live (Unix timestamp format)

solution*enum

Solution of the Live

YoutubeVimeoBuiltInNoSolution

builtInTypenullable enum

BuiltIn type of the Live (if solution is BuiltIn)

WorkshopConference

videoUrlnullable object

Video URL of the Live (if solution is Youtube or Vimeo)

chatVisibilityenum

The chat visibility on the Live

DisplayHidden

participantsVisibilityenum

The participant list visibility on the Live

DisplayHidden

visibilityenum

The Live visibility

AnyOneOnlySpotMembersInvitedMembersOnly

participationenum

Who kind of members can participate to the Live

AnySpotMembersInvitedMembersOnly

recordboolean

Active the record on the Live

Response

201400

Live has been successfully created

Body

application/json

id*string

The id of the Live.

title*string

The title of the Live.

startDate*string (date-time)

The startDate of the Live.

endDate*string (date-time)

The endDate of the Live.

metrics*all of

The metrics of the Live.

description*array of string

The description of the Live.

status*enum

The status of the Live.

EndedPlannedLive

computedStatus*enum

The computed status of the Live.

EndedPlannedLive

solution*enum

The solution of the Live.

YoutubeVimeoBuiltInNoSolution

privacy*all of

The privacy of the Live.

config*all of

The configuration of the Live.

builtInType*nullable enum

The builtIn type of the Live.

WorkshopConference

videoUrl*nullable object

The video URL of the Live.

createdAt*string (date-time)

The creation date of the Live.

spotId*string

The spot ID of the Live.

builtInConfig*nullable all of

The builtIn configuration of the Live.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "description": "text",
      "spotMemberHostId": "text",
      "solution": "Youtube"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "title": "text",
  "startDate": "2024-09-08T01:02:09.276Z",
  "endDate": "2024-09-08T01:02:09.276Z",
  "metrics": {},
  "description": [
    "text"
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-09-08T01:02:09.276Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-09-08T01:02:09.276Z"
    }
  }
}

Get a Live

GET/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Response

200400404

Live found and returned successfully

Body

application/json

id*string

The id of the Live.

title*string

The title of the Live.

startDate*string (date-time)

The startDate of the Live.

endDate*string (date-time)

The endDate of the Live.

metrics*all of

The metrics of the Live.

description*array of string

The description of the Live.

status*enum

The status of the Live.

EndedPlannedLive

computedStatus*enum

The computed status of the Live.

EndedPlannedLive

solution*enum

The solution of the Live.

YoutubeVimeoBuiltInNoSolution

privacy*all of

The privacy of the Live.

config*all of

The configuration of the Live.

builtInType*nullable enum

The builtIn type of the Live.

WorkshopConference

videoUrl*nullable object

The video URL of the Live.

createdAt*string (date-time)

The creation date of the Live.

spotId*string

The spot ID of the Live.

builtInConfig*nullable all of

The builtIn configuration of the Live.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "title": "text",
  "startDate": "2024-09-08T01:02:09.276Z",
  "endDate": "2024-09-08T01:02:09.276Z",
  "metrics": {},
  "description": [
    "text"
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-09-08T01:02:09.276Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-09-08T01:02:09.276Z"
    }
  }
}

Update a Live

PUT/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Body

application/json

title*string

The title of the Live

description*string

Description of the Live (in Markdown)

startDate*integer

Start date of the Live (Unix timestamp format)

endDate*integer

End date of the Live (Unix timestamp format)

chatVisibilityenum

The chat visibility on the Live

DisplayHidden

participantsVisibilityenum

The participant list visibility on the Live

DisplayHidden

visibilityenum

The Live visibility

AnyOneOnlySpotMembersInvitedMembersOnly

participationenum

Who kind of members can participate to the Live

AnySpotMembersInvitedMembersOnly

solution*enum

Solution of the Live

YoutubeVimeoBuiltInNoSolution

builtInTypeenum

BuiltIn type of the Live (if solution is BuiltIn)

WorkshopConference

recordboolean

Active the record on the Live

recordAvailableboolean

Make available the record of the Live

videoUrlstring

Video URL of the Live (if solution is Youtube or Vimeo)

replayVideoUrlnullable object

Video URL of the Live (if solution is Youtube or Vimeo)

Response

200400404

Live successfully updated

Body

application/json

id*string

The id of the Live.

title*string

The title of the Live.

startDate*string (date-time)

The startDate of the Live.

endDate*string (date-time)

The endDate of the Live.

metrics*all of

The metrics of the Live.

description*array of string

The description of the Live.

status*enum

The status of the Live.

EndedPlannedLive

computedStatus*enum

The computed status of the Live.

EndedPlannedLive

solution*enum

The solution of the Live.

YoutubeVimeoBuiltInNoSolution

privacy*all of

The privacy of the Live.

config*all of

The configuration of the Live.

builtInType*nullable enum

The builtIn type of the Live.

WorkshopConference

videoUrl*nullable object

The video URL of the Live.

createdAt*string (date-time)

The creation date of the Live.

spotId*string

The spot ID of the Live.

builtInConfig*nullable all of

The builtIn configuration of the Live.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "description": "text",
      "solution": "Youtube"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "title": "text",
  "startDate": "2024-09-08T01:02:09.276Z",
  "endDate": "2024-09-08T01:02:09.276Z",
  "metrics": {},
  "description": [
    "text"
  ],
  "status": "Ended",
  "computedStatus": "Ended",
  "solution": "Youtube",
  "privacy": {
    "visibility": "AnyOne",
    "participation": "AnySpotMembers"
  },
  "config": {
    "chatVisibility": "Display",
    "participantsVisibility": "Ended"
  },
  "builtInType": "Workshop",
  "createdAt": "2024-09-08T01:02:09.276Z",
  "spotId": "text",
  "builtInConfig": {
    "isRecorded": false,
    "recordAvailable": false,
    "videos": {
      "url": "text",
      "quality": "text",
      "encoding": "hls",
      "createdAt": "2024-09-08T01:02:09.276Z"
    }
  }
}

Delete a Live

DELETE/v1/lives/{liveId}

Path parameters

liveId*string

The id of the Live

Response

204400404

Live successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Unlink a group from a live

DELETE/v1/lives/{liveId}/groups/{groupId}

Path parameters

liveId*string

The id of the Live

groupId*string

The id of the group

Response

204400404

Group successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/groups/{groupId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Unlink groups from a live

POST/v1/lives/{liveId}/groups~bulkRemove

Path parameters

liveId*string

The id of the Live

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400404

Groups successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/groups~bulkRemove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Link a group

GET/v1/lives/{liveId}/groups

Path parameters

liveId*string

The id of the Live

Query parameters

Response

200400404

Group 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('/v1/lives/{liveId}/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Link a group

POST/v1/lives/{liveId}/groups

Path parameters

liveId*string

The id of the Live

Body

application/json

groupId*string

The id of the group to link

withEmailNotificationboolean

To send an email notification to each added member. Disable by default.

Response

204400404

Group linked successfully

Request

JavaScriptCurlPython

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

Link groups

POST/v1/lives/{liveId}/groups~bulkAdd

Path parameters

liveId*string

The id of the Live

Body

application/json

groupIds*array of string

The ids of the groups to link

withEmailNotificationboolean

To send an email notification to each added member. Disable by default.

Response

204400404

Groups linked successfully

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/groups~bulkAdd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

List Live speakers

GET/v1/lives/{liveId}/speakers

Path parameters

liveId*string

The id of the Live

Query parameters

Response

200400

Live speakers returned successfully

Body

application/json

items*array of LiveParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/speakers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2024-09-08T01:02:09.276Z",
      "registeredAt": "2024-09-08T01:02:09.276Z",
      "isHighlighted": false,
      "metrics": {
        "hasReplayed": false,
        "hasParticipated": false
      }
    }
  ]
}

Invite a member as Live speaker

POST/v1/lives/{liveId}/speakers

Path parameters

liveId*string

The id of the Live

Body

application/json

member*one of

Member to invite as Live participant from email address or existing Spot member ID

InviteLiveSpeakerByEmailApiBody (object)string

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

highlightedboolean

Set to true to highlight the Speaker. False by default

grantHostRightsboolean

Set to true to grant Host rights to the Speaker. False by default

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

200400

Member has been successfully invited

Body

application/json

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

type*enum

The type of the participant.

ParticipantSpeakerHost

invitedAt*nullable string (date-time)

The invitation date of the participant.

registeredAt*nullable string (date-time)

The registration date of the participant.

isHighlighted*boolean

The highlight value of the participant.

metrics*all of

The metrics of the participant.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/speakers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "member": {
        "email": "text",
        "firstName": "text",
        "lastName": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "liveId": "text",
  "status": "Accepted",
  "type": "Participant",
  "invitedAt": "2024-09-08T01:02:09.276Z",
  "registeredAt": "2024-09-08T01:02:09.276Z",
  "isHighlighted": false,
  "metrics": {
    "hasReplayed": false,
    "hasParticipated": false
  }
}

List Live participants

GET/v1/lives/{liveId}/participants

Path parameters

liveId*string

The id of the Live

Query parameters

Response

200400

Live participants returned successfully

Body

application/json

items*array of LiveParticipantApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "liveId": "text",
      "status": "Accepted",
      "type": "Participant",
      "invitedAt": "2024-09-08T01:02:09.276Z",
      "registeredAt": "2024-09-08T01:02:09.276Z",
      "isHighlighted": false,
      "metrics": {
        "hasReplayed": false,
        "hasParticipated": false
      }
    }
  ]
}

Invite a member as Live participant

POST/v1/lives/{liveId}/participants

Path parameters

liveId*string

The id of the Live

Body

application/json

member*string

Member to invite as Live participant from email address or existing Spot member ID

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Response

200400

Member has been successfully invited

Body

application/json

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

type*enum

The type of the participant.

ParticipantSpeakerHost

invitedAt*nullable string (date-time)

The invitation date of the participant.

registeredAt*nullable string (date-time)

The registration date of the participant.

isHighlighted*boolean

The highlight value of the participant.

metrics*all of

The metrics of the participant.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/participants', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "member": "text"
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "liveId": "text",
  "status": "Accepted",
  "type": "Participant",
  "invitedAt": "2024-09-08T01:02:09.276Z",
  "registeredAt": "2024-09-08T01:02:09.276Z",
  "isHighlighted": false,
  "metrics": {
    "hasReplayed": false,
    "hasParticipated": false
  }
}

Invite multiple members as Live participant

POST/v1/lives/{liveId}/participants~bulkInvite

Path parameters

liveId*string

The id of the Live

Body

application/json

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

members*all of

Members to invite

Response

200400413

Members has been successfully invited

Body

application/json

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

type*enum

The type of the participant.

ParticipantSpeakerHost

invitedAt*nullable string (date-time)

The invitation date of the participant.

registeredAt*nullable string (date-time)

The registration date of the participant.

isHighlighted*boolean

The highlight value of the participant.

metrics*all of

The metrics of the participant.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/participants~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "members": {}
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "liveId": "text",
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2024-09-08T01:02:09.276Z",
    "registeredAt": "2024-09-08T01:02:09.276Z",
    "isHighlighted": false,
    "metrics": {
      "hasReplayed": false,
      "hasParticipated": false
    }
  }
]

Invite multiple members as Live speaker

POST/v1/lives/{liveId}/speakers~bulkInvite

Path parameters

liveId*string

The id of the Live

Body

application/json

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

highlightedboolean

Set to true to highlight the Speaker.

grantHostRightsboolean

Set to true to grant Host rights to the Speaker.

withEmailNotificationboolean

Set to true to send notification mail to each invited members

spotMemberIds*array of string

Spot members to invite as Live speaker

Response

200400413

Members has been successfully invited

Body

application/json

id*string

The id of the participant.

liveId*string

The Live id of the participant.

status*enum

The status of the participant.

AcceptedInvited

type*enum

The type of the participant.

ParticipantSpeakerHost

invitedAt*nullable string (date-time)

The invitation date of the participant.

registeredAt*nullable string (date-time)

The registration date of the participant.

isHighlighted*boolean

The highlight value of the participant.

metrics*all of

The metrics of the participant.

Request

JavaScriptCurlPython

const response = await fetch('/v1/lives/{liveId}/speakers~bulkInvite', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "liveId": "text",
    "status": "Accepted",
    "type": "Participant",
    "invitedAt": "2024-09-08T01:02:09.276Z",
    "registeredAt": "2024-09-08T01:02:09.276Z",
    "isHighlighted": false,
    "metrics": {
      "hasReplayed": false,
      "hasParticipated": false
    }
  }
]

Channels

List Channel members

GET/v1/channels/{channelId}/spotMembers

Path parameters

channelId*string

The id of the channel

Query parameters

Response

200400

Channel 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('/v1/channels/{channelId}/spotMembers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Add member to a channel

POST/v1/channels/{channelId}/spotMembers

Path parameters

channelId*string

The id of the channel

Body

application/json

spotMemberId*string

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

Response

204400404

Member successfully added

Request

JavaScriptCurlPython

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

List channels

GET/v1/channels

Query parameters

Response

200400

Channels returned successfully

Body

application/json

items*array of ChannelApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": "text",
      "privacy": "Private",
      "autoJoin": false,
      "showMembers": false
    }
  ]
}

Create a channel

POST/v1/channels

Body

application/json

name*string

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoin*boolean

Whether the channel should be auto-joined by new members.

showMembers*boolean

Whether the channel should show its members.

privacy*enum

Privacy setting of the channel

PrivatePublic

Response

201400

Channel has been successfully created

Body

application/json

id*string

The id of the channel.

name*string

The name of the channel.

emojistring

The emoji of the channel

description*string

The description of the channel.

privacy*enum

The privacy of the channel.

PrivatePublic

autoJoin*boolean

Whether the channel will be auto-joined by new members.

showMembers*boolean

Whether the channel will show its members.

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "autoJoin": false,
      "showMembers": false,
      "privacy": "Private"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": "text",
  "privacy": "Private",
  "autoJoin": false,
  "showMembers": false
}

Get a channel

GET/v1/channels/{channelId}

Path parameters

channelId*string

The id of the channel

Response

200400404

Channel found and returned successfully

Body

application/json

id*string

The id of the channel.

name*string

The name of the channel.

emojistring

The emoji of the channel

description*string

The description of the channel.

privacy*enum

The privacy of the channel.

PrivatePublic

autoJoin*boolean

Whether the channel will be auto-joined by new members.

showMembers*boolean

Whether the channel will show its members.

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": "text",
  "privacy": "Private",
  "autoJoin": false,
  "showMembers": false
}

Update a channel

PUT/v1/channels/{channelId}

Path parameters

channelId*string

The id of the channel

Body

application/json

namestring

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoinboolean

Whether the channel should be auto-joined by new members.

showMembersboolean

Whether the channel should show its members.

privacyenum

Privacy setting of the channel

PrivatePublic

Response

200400404

Channel successfully updated

Body

application/json

id*string

The id of the channel.

name*string

The name of the channel.

emojistring

The emoji of the channel

description*string

The description of the channel.

privacy*enum

The privacy of the channel.

PrivatePublic

autoJoin*boolean

Whether the channel will be auto-joined by new members.

showMembers*boolean

Whether the channel will show its members.

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "emoji": "text",
  "description": "text",
  "privacy": "Private",
  "autoJoin": false,
  "showMembers": false
}

Delete a channel

DELETE/v1/channels/{channelId}

Path parameters

channelId*string

The id of the channel

Response

204400404

Channel successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add members to a channel

POST/v1/channels/{channelId}/spotMembers~bulkAdd

Path parameters

channelId*string

The id of the channel

Body

application/json

spotMemberIds*array of string

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

Response

200400404

Members successfully added

Body

application/json

addedSpotMemberIds*array of string

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

failedSpotMemberIds*array of string

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

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}/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 members from a channel

POST/v1/channels/{channelId}/spotMembers~bulkRemove

Path parameters

channelId*string

The id of the channel

Body

application/json

spotMemberIds*array of string

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

Response

200400404

Members successfully removed

Body

application/json

removedSpotMembersCount*integer

The number of members removed from the channel.

Request

JavaScriptCurlPython

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

Response

200

{}

Create multiple channels

POST/v1/channels~bulkCreate

Body

application/json

name*string

The name of the channel.

descriptionstring

The description of the channel

emojistring

The emoji of the channel

autoJoin*boolean

Whether the channel should be auto-joined by new members.

showMembers*boolean

Whether the channel should show its members.

privacy*enum

Privacy setting of the channel

PrivatePublic

Response

201400413

Channels has been successfully created

Body

application/json

created*array of ChannelApiResponse (object)

The channels that were created.

failed*array of CreateChannelApiBody (object)

The channels that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels~bulkCreate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "autoJoin": false,
        "showMembers": false,
        "privacy": "Private"
      }
    ]),
});
const data = await response.json();

Response

201

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": "text",
      "privacy": "Private",
      "autoJoin": false,
      "showMembers": false
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "autoJoin": false,
      "showMembers": false,
      "privacy": "Private"
    }
  ]
}

list a group

GET/v1/channels/{channelId}/groups

Path parameters

channelId*string

The id of the channel

Query parameters

Response

200400404

Group 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('/v1/channels/{channelId}/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Link a group

POST/v1/channels/{channelId}/groups

Path parameters

channelId*string

The id of the channel

Body

application/json

groupId*string

The id of the group to link

Response

204400404

Group linked successfully

Request

JavaScriptCurlPython

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

Unlink a group from a channel

DELETE/v1/channels/{channelId}/groups/{groupId}

Path parameters

channelId*string

The id of the channel

groupId*string

The id of the group

Response

204400404

Group successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}/groups/{groupId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Link groups

POST/v1/channels/{channelId}/groups~bulkAdd

Path parameters

channelId*string

The id of the channel

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400404

Groups linked successfully

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}/groups~bulkAdd', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Unlink groups from a channel

POST/v1/channels/{channelId}/groups~bulkRemove

Path parameters

channelId*string

The id of the channel

Body

application/json

groupIds*array of string

The ids of the groups to link

Response

204400404

Groups successfully unlink

Request

JavaScriptCurlPython

const response = await fetch('/v1/channels/{channelId}/groups~bulkRemove', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "groupIds": [
        "text"
      ]
    }),
});
const data = await response.json();

Forums

Get a forum

GET/v1/forums/{forumId}

Path parameters

forumId*string

The id of the forum

Response

200400404

Forum found and returned successfully

Body

application/json

id*string

The id of the forum.

name*string

The name of the forum.

emojistring

The emoji of the forum

description*string

The description of the forum

createdAt*integer

Timestamp in ms of creation date

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a forum

PUT/v1/forums/{forumId}

Path parameters

forumId*string

The id of the forum

Body

application/json

namestring

The name of the forum

descriptionnullable string

The description of the forum

emojinullable string

The emoji of the forum

Response

200400404

Forum successfully updated

Body

application/json

id*string

The id of the forum.

name*string

The name of the forum.

emojistring

The emoji of the forum

description*string

The description of the forum

createdAt*integer

Timestamp in ms of creation date

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

Delete a forum

DELETE/v1/forums/{forumId}

Path parameters

forumId*string

The id of the forum

Response

204400404

Forum successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

List forums

GET/v1/forums

Query parameters

Response

200400

Forums returned successfully

Body

application/json

items*array of ForumApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a forum

POST/v1/forums

Body

application/json

name*string

Name of the forum

descriptionstring

Description of the forum

emojistring

Emoji of the forum

Response

201400

The forum has been successfully created

Body

application/json

id*string

The id of the forum.

name*string

The name of the forum.

emojistring

The emoji of the forum

description*string

The description of the forum

createdAt*integer

Timestamp in ms of creation date

Request

JavaScriptCurlPython

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

Response

201

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

Create multiple forums

POST/v1/forums~bulkCreate

Body

application/json

name*string

Name of the forum

descriptionstring

Description of the forum

emojistring

Emoji of the forum

Response

201400413

Forums has been successfully created

Body

application/json

created*array of ForumApiResponse (object)

The forums that were created.

failed*array of CreateForumApiBody (object)

The forums that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums~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",
      "emoji": "text",
      "description": "text"
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text"
    }
  ]
}

Topics

Get a topic

GET/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumId*string

The id of the forum

topicId*string

The id of the topic

Response

200400404

Topic found and returned successfully

Body

application/json

id*string

The id of the topic.

name*string

The name of the topic.

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}/topics/{topicId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text"
}

Update a topic

PUT/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumId*string

The id of the forum

topicId*string

The id of the topic

Body

application/json

namestring

Name of the topic

contentarray of string

Content of the topic

Response

200400404

Topic successfully updated

Body

application/json

id*string

The id of the topic.

name*string

The name of the topic.

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}/topics/{topicId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text"
}

Delete a topic

DELETE/v1/forums/{forumId}/topics/{topicId}

Path parameters

forumId*string

The id of the forum

topicId*string

The id of the topic

Response

204400404

Topic successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}/topics/{topicId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

List topics

GET/v1/forums/{forumId}/topics

Path parameters

forumId*string

The id of the forum

Query parameters

Response

200400

Topics returned successfully

Body

application/json

items*array of TopicApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}/topics', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Create a topic

POST/v1/forums/{forumId}/topics

Path parameters

forumId*string

The id of the forum

Body

application/json

name*string

Name of the topic

content*string

Content of the topic (in Markdown)

Response

201400

Topic has been successfully created

Body

application/json

id*string

The id of the topic.

name*string

The name of the topic.

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}/topics', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "content": "text"
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "name": "text"
}

Create multiple topics

POST/v1/forums/{forumId}/topics~bulkCreate

Path parameters

forumId*string

ID of the forum

Body

application/json

name*string

Name of the topic

content*string

Content of the topic (in Markdown)

Response

201400413

Topics has been successfully created

Body

application/json

created*array of ChannelApiResponse (object)

The channels that were created.

failed*array of CreateChannelApiBody (object)

The channels that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('/v1/forums/{forumId}/topics~bulkCreate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "name": "text",
        "content": "text"
      }
    ]),
});
const data = await response.json();

Response

201

{
  "created": [
    {
      "id": "text",
      "name": "text",
      "emoji": "text",
      "description": "text",
      "privacy": "Private",
      "autoJoin": false,
      "showMembers": false
    }
  ],
  "failed": [
    {
      "name": "text",
      "description": "text",
      "emoji": "text",
      "autoJoin": false,
      "showMembers": false,
      "privacy": "Private"
    }
  ]
}

Search

Search for resources in the spot

GET/v1/search

Query parameters

Response

200400

Search results

Body

application/json

items*array of any of

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "type": "Topic",
      "topicTitle": "text",
      "topicContent": "text",
      "forumName": "text",
      "topicAuthorPictureUrl": "text",
      "topicAuthorName": "text",
      "spotId": "text",
      "forumId": "text",
      "topicId": "text"
    }
  ]
}

Groups

List Group members

GET/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('/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",
      "firstname": "text",
      "lastname": "text"
    }
  ]
}

Add member to a group

POST/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('/v1/groups/{groupId}/spotMembers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "spotMemberId": "text"
    }),
});
const data = await response.json();

List groups

GET/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('/v1/groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a group

POST/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('/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"
}

Get a group

GET/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('/v1/groups/{groupId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a group

PUT/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('/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"
}

Delete a group

DELETE/v1/groups/{groupId}

Path parameters

groupId*string

The id of the group

Response

204400404

Group successfully deleted

Request

JavaScriptCurlPython

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

Add members to a group

POST/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

addedSpotMembersCount*integer

The number of members added to the group.

Request

JavaScriptCurlPython

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

Response

200

{}

Remove members from a group

POST/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('/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

POST/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('/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"
    }
  ]
}

Tags

List tags

GET/v1/tags

Query parameters

Response

200400

Tags returned successfully

Body

application/json

items*array of TagApiResponse (object)

The items found

total*integer

The total number of items found

Request

JavaScriptCurlPython

const response = await fetch('/v1/tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a tag

POST/v1/tags

Body

application/json

name*string

Name of the tag

emojistring

Emoji of the tag

Response

201400

The tag has been successfully created

Body

application/json

id*string

The id of the tag.

name*string

The name of the tag.

emojistring

The emoji of the tag

order*integer

The order of the tag.

Request

JavaScriptCurlPython

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

Response

201

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

Get a tag

GET/v1/tags/{tagId}

Path parameters

tagId*string

The id of the tag

Response

200400404

Tag found and returned successfully

Body

application/json

id*string

The id of the tag.

name*string

The name of the tag.

emojistring

The emoji of the tag

order*integer

The order of the tag.

Request

JavaScriptCurlPython

const response = await fetch('/v1/tags/{tagId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update a tag

PUT/v1/tags/{tagId}

Path parameters

tagId*string

The id of the tag

Body

application/json

namestring

The name of the tag

emojinullable string

The emoji of the tag

Response

200400404

Tag successfully updated

Body

application/json

id*string

The id of the tag.

name*string

The name of the tag.

emojistring

The emoji of the tag

order*integer

The order of the tag.

Request

JavaScriptCurlPython

const response = await fetch('/v1/tags/{tagId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

Delete a tag

DELETE/v1/tags/{tagId}

Path parameters

tagId*string

The id of the tag

Response

204400404

Tag successfully deleted

Request

JavaScriptCurlPython

const response = await fetch('/v1/tags/{tagId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create multiple tags

POST/v1/tags~bulkCreate

Body

application/json

name*string

Name of the tag

emojistring

Emoji of the tag

Response

201400413

Tags has been successfully created

Body

application/json

created*array of TagApiResponse (object)

The tags that were created.

failed*array of CreateTagApiBody (object)

The tags that failed to be created.

Request

JavaScriptCurlPython

const response = await fetch('/v1/tags~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",
      "emoji": "text"
    }
  ],
  "failed": [
    {
      "name": "text",
      "emoji": "text"
    }
  ]
}

Notifications

Get unread notifications count

GET/v1/spotMembers/{spotMemberId}/notifications~unreadCount

Path parameters

spotMemberId*string

The id of the Spot member

Query parameters

Response

200400404

Counter of unread notification returned successfully

Body

application/json

count*number

Sum of counters

countByTypes*array of UnreadNotificationsCountByTypeApiResponse (object)

Unread notifications by types

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}/notifications~unreadCount', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 0,
  "countByTypes": [
    {
      "type": "AskJoinPrivateSpot",
      "count": 0
    }
  ]
}

Mark notifications as read

POST/v1/spotMembers/{spotMemberId}/notifications~markAsRead

Path parameters

spotMemberId*string

The id of the Spot member

Body

application/json

idall of

Filters on notifications to include

Response

200400

Notifications successfully marked as read

Body

application/json

id*string

The id of the notification.

userId*string

The user id of the notification.

logId*string

The log id of the notification.

isRead*boolean

To know if notification was read

createdAt*string (date-time)

The creation date of the notification.

log*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}/notifications~markAsRead', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "userId": "text",
    "logId": "text",
    "isRead": false,
    "createdAt": "2024-09-08T01:02:09.276Z",
    "log": {
      "id": "text",
      "spotId": "text",
      "type": "AskJoinPrivateSpot"
    }
  }
]

List notifications

GET/v1/spotMembers/{spotMemberId}/notifications

Path parameters

spotMemberId*string

The id of the Spot member

Query parameters

Response

200400404

Notifications returned successfully

Body

application/json

items*array of NotificationApiResponse (object)

The items found

hasMore*boolean

Indicate if more items are available

Request

JavaScriptCurlPython

const response = await fetch('/v1/spotMembers/{spotMemberId}/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "userId": "text",
      "logId": "text",
      "isRead": false,
      "createdAt": "2024-09-08T01:02:09.276Z",
      "log": {
        "id": "text",
        "spotId": "text",
        "type": "AskJoinPrivateSpot"
      }
    }
  ],
  "hasMore": false
}