Download OpenAPI specification:
LE-KO Groups
✨ Create a new group
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| name required | string <= 60 characters | ||||||||||||||
| description required | string <= 1000 characters | ||||||||||||||
| sportId | string <uuid> (SportId) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Sport Type UUID | ||||||||||||||
| coverId | string <uuid> (CoverId) Cover ID | ||||||||||||||
| avatarId | string <uuid> (AvatarId) Avatar ID | ||||||||||||||
object (GeosuggestedAddress) | |||||||||||||||
| |||||||||||||||
| shortName required | string (ShortName) [ 5 .. 32 ] characters ^[a-z0-9_]{5,32}$ Short Name for group | ||||||||||||||
| postRules required | string (PostRules) Enum: "Everyone" "AdminApproval" "OnlyAdmin" | ||||||||||||||
object (Location) | |||||||||||||||
| |||||||||||||||
{- "name": "string",
- "description": "string",
- "sportId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
- "coverId": "00000000-0000-1000-9000-510d9bb07630",
- "avatarId": "00000000-0000-1000-9000-510d9bb07630",
- "address": {
- "title": "string",
- "formattedAddress": "string",
- "street": "string",
- "region": "string",
- "city": "string",
- "tags": [
- "string"
], - "subtitle": "string"
}, - "shortName": "group_123",
- "postRules": "Everyone",
- "location": {
- "lat": -90,
- "lng": -180
}
}{- "id": "00000000-0000-1000-9000-510d9bb07630"
}✨ Get groups
| groupName | string (GroupName) <= 60 characters Example: groupName=SomeName Group Name |
| sportId | string <uuid> (SportId) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Example: sportId=4b72d209-debd-45e1-93cc-7640bf7d39bf Sport Type UUID |
object (Address) | |
| myGroups | boolean |
| isFollowing | boolean |
| includeFollowing | boolean When used with myGroups=true, also includes groups the user is following (not just created/admin groups) |
| lat | number <double> [ -90 .. 90 ] |
| lng | number <double> [ -180 .. 180 ] |
| isPopular | boolean |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| id | string <uuid> (GroupId) Group ID |
| name | string |
| description | string |
| sportId | string <uuid> (SportId) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Sport Type UUID |
| coverId | string <uuid> (CoverId) Cover ID |
| avatarId | string <uuid> (AvatarId) Avatar ID |
| shortName | string (ShortName) [ 5 .. 32 ] characters ^[a-z0-9_]{5,32}$ Short Name for group |
| postRules | string (PostRules) Enum: "Everyone" "AdminApproval" "OnlyAdmin" |
| address | string |
| groupType | string (GroupType) Enum: "Public" "Private" |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| ownerId | string <uuid> (OwnerId) Owner ID |
| participantsCount | integer |
| participantsIds | Array of strings <uuid> (ParticipantId) [ items <uuid > ] |
| isFollowing | boolean |
| distance | number <double> >= 0 Distance in kilometers |
[- {
- "id": "00000000-0000-1000-9000-510d9bb07630",
- "name": "string",
- "description": "string",
- "sportId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
- "coverId": "00000000-0000-1000-9000-510d9bb07630",
- "avatarId": "00000000-0000-1000-9000-510d9bb07630",
- "shortName": "group_123",
- "postRules": "Everyone",
- "address": "string",
- "groupType": "Public",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "ownerId": "00000000-0000-1000-9000-510d9bb07630",
- "participantsCount": 0,
- "participantsIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "isFollowing": true,
- "distance": 0.1
}
]✨ Update a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
object (GeosuggestedAddress) | |||||||||||||||
| |||||||||||||||
| name required | string <= 60 characters | ||||||||||||||
| description required | string <= 1000 characters | ||||||||||||||
| sportId | string <uuid> (SportId) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Sport Type UUID | ||||||||||||||
| coverId | string <uuid> (CoverId) Cover ID | ||||||||||||||
| avatarId | string <uuid> (AvatarId) Avatar ID | ||||||||||||||
| shortName required | string (ShortName) [ 5 .. 32 ] characters ^[a-z0-9_]{5,32}$ Short Name for group | ||||||||||||||
| postRules required | string (PostRules) Enum: "Everyone" "AdminApproval" "OnlyAdmin" | ||||||||||||||
object (Location) | |||||||||||||||
| |||||||||||||||
| id | string <uuid> (GroupId) Group ID |
| name | string |
| description | string |
| sportId | string <uuid> (SportId) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Sport Type UUID |
| coverId | string <uuid> (CoverId) Cover ID |
| avatarId | string <uuid> (AvatarId) Avatar ID |
| shortName | string (ShortName) [ 5 .. 32 ] characters ^[a-z0-9_]{5,32}$ Short Name for group |
| postRules | string (PostRules) Enum: "Everyone" "AdminApproval" "OnlyAdmin" |
| address | string |
| groupType | string (GroupType) Enum: "Public" "Private" |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| ownerId | string <uuid> (OwnerId) Owner ID |
| participantsCount | integer |
| participantsIds | Array of strings <uuid> (ParticipantId) [ items <uuid > ] |
| isFollowing | boolean |
| distance | number <double> >= 0 Distance in kilometers |
{- "address": {
- "title": "string",
- "formattedAddress": "string",
- "street": "string",
- "region": "string",
- "city": "string",
- "tags": [
- "string"
], - "subtitle": "string"
}, - "name": "string",
- "description": "string",
- "sportId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
- "coverId": "00000000-0000-1000-9000-510d9bb07630",
- "avatarId": "00000000-0000-1000-9000-510d9bb07630",
- "shortName": "group_123",
- "postRules": "Everyone",
- "location": {
- "lat": -90,
- "lng": -180
}
}{- "id": "00000000-0000-1000-9000-510d9bb07630",
- "name": "string",
- "description": "string",
- "sportId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
- "coverId": "00000000-0000-1000-9000-510d9bb07630",
- "avatarId": "00000000-0000-1000-9000-510d9bb07630",
- "shortName": "group_123",
- "postRules": "Everyone",
- "address": "string",
- "groupType": "Public",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "ownerId": "00000000-0000-1000-9000-510d9bb07630",
- "participantsCount": 0,
- "participantsIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "isFollowing": true,
- "distance": 0.1
}✨ Get a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| id | string <uuid> (GroupId) Group ID |
| name | string |
| description | string |
| sportId | string <uuid> (SportId) = 36 characters ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}... Sport Type UUID |
| coverId | string <uuid> (CoverId) Cover ID |
| avatarId | string <uuid> (AvatarId) Avatar ID |
| shortName | string (ShortName) [ 5 .. 32 ] characters ^[a-z0-9_]{5,32}$ Short Name for group |
| postRules | string (PostRules) Enum: "Everyone" "AdminApproval" "OnlyAdmin" |
| address | string |
| groupType | string (GroupType) Enum: "Public" "Private" |
| createdAt | string <date-time> |
| updatedAt | string <date-time> |
| ownerId | string <uuid> (OwnerId) Owner ID |
| participantsCount | integer |
| participantsIds | Array of strings <uuid> (ParticipantId) [ items <uuid > ] |
| isFollowing | boolean |
| distance | number <double> >= 0 Distance in kilometers |
{- "id": "00000000-0000-1000-9000-510d9bb07630",
- "name": "string",
- "description": "string",
- "sportId": "4b72d209-debd-45e1-93cc-7640bf7d39bf",
- "coverId": "00000000-0000-1000-9000-510d9bb07630",
- "avatarId": "00000000-0000-1000-9000-510d9bb07630",
- "shortName": "group_123",
- "postRules": "Everyone",
- "address": "string",
- "groupType": "Public",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "ownerId": "00000000-0000-1000-9000-510d9bb07630",
- "participantsCount": 0,
- "participantsIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "isFollowing": true,
- "distance": 0.1
}✨ Delete a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Follow a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Unfollow a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Get a group feed
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| page | integer (PageNumber) >= 0 Default: 0 Example: page=0 Page number |
| limit | integer (PageLimit) [ 1 .. 100 ] Default: 10 Example: limit=10 Page limit |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
Array of objects | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
| count required | integer (Count) Page entries count | ||||||||||||||||||||||||
| currentPage | integer (CurrentPage) >= 0 Deprecated Default: 0 Current page | ||||||||||||||||||||||||
| page required | integer (PageNumber) >= 0 Default: 0 Page number | ||||||||||||||||||||||||
| pageSize | integer (PageSize) [ 1 .. 100 ] Deprecated Default: 10 Page size | ||||||||||||||||||||||||
| limit required | integer (PageLimit) [ 1 .. 100 ] Default: 10 Page limit | ||||||||||||||||||||||||
| total required | integer (TotalCount) >= 0 Default: 0 Total count | ||||||||||||||||||||||||
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "mediaIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "likeCount": 0,
- "commentCount": 0,
- "likedByUser": true,
- "commentedByUser": true,
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}
], - "count": 10,
- "currentPage": 0,
- "page": 0,
- "pageSize": 10,
- "limit": 10,
- "total": 1000
}✨ Deletes all user-related data from the groups system including:
If userId parameter is provided, deletes the specified user (admin only). If userId is not provided, deletes the current user (from x-current-user-id header).
| userId | string <uuid> Example: userId=4b72d209-debd-45e1-93cc-7640bf7d39bf User ID to delete. If not provided, deletes the current user (from x-current-user-id header). Only admins can delete other users. |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}| userId | string <uuid> Example: userId=4b72d209-debd-45e1-93cc-7640bf7d39bf User ID to delete. If not provided, deletes the current user (from x-current-user-id header). Only admins can delete other users. |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Get participants of a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| isMuted | boolean |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| userId required | string <uuid> (ParticipantId) Participant ID |
| isMuted required | boolean |
| isAdmin required | boolean |
[- {
- "userId": "00000000-0000-1000-9000-510d9bb07630",
- "isMuted": true,
- "isAdmin": true
}
]✨ Remove a participant from a group
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| participantId required | string <uuid> (ParticipantId) Example: 00000000-0000-1000-9000-510d9bb07630 Participant ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Mute a participant
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| participantId required | string <uuid> (ParticipantId) Example: 00000000-0000-1000-9000-510d9bb07630 Participant ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Unmute a participant
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| participantId required | string <uuid> (ParticipantId) Example: 00000000-0000-1000-9000-510d9bb07630 Participant ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Create a new post
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| text required | string <= 2000 characters | ||||
| mediaIds | Array of strings <uuid> (MediaId) <= 6 items [ items <uuid > ] | ||||
Array of objects (PostMention) | |||||
Array
| |||||
{- "text": "string",
- "mediaIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}{- "id": "00000000-0000-1000-9000-510d9bb07630"
}✨ Update a post
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| text required | string <= 2000 characters | ||||
| mediaIds | Array of strings <uuid> (MediaId) <= 6 items [ items <uuid > ] | ||||
Array of objects (PostMention) | |||||
Array
| |||||
{- "text": "string",
- "mediaIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Delete a post
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Get a post
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| id required | string <uuid> | ||||
| text required | string | ||||
| createdAt required | string <date-time> | ||||
| updatedAt required | string <date-time> | ||||
| authorId required | string <uuid> | ||||
| groupId required | string <uuid> | ||||
| mediaIds required | Array of strings <uuid> (MediaId) [ items <uuid > ] | ||||
| likeCount required | integer | ||||
| commentCount required | integer | ||||
| likedByUser required | boolean | ||||
| commentedByUser required | boolean | ||||
Array of objects (PostMention) | |||||
Array
| |||||
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "mediaIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "likeCount": 0,
- "commentCount": 0,
- "likedByUser": true,
- "commentedByUser": true,
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}✨ Get suggested posts
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| id required | string <uuid> | ||||
| text required | string | ||||
| createdAt required | string <date-time> | ||||
| updatedAt required | string <date-time> | ||||
| authorId required | string <uuid> | ||||
| groupId required | string <uuid> | ||||
| mediaIds required | Array of strings <uuid> (MediaId) [ items <uuid > ] | ||||
| likeCount required | integer | ||||
| commentCount required | integer | ||||
| likedByUser required | boolean | ||||
| commentedByUser required | boolean | ||||
Array of objects (PostMention) | |||||
Array
| |||||
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "mediaIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "likeCount": 0,
- "commentCount": 0,
- "likedByUser": true,
- "commentedByUser": true,
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}
]✨ Get all pending approval posts for groups where the logged-in user is an admin
| page | integer (PageNumber) >= 0 Default: 0 Example: page=0 Page number |
| limit | integer (PageLimit) [ 1 .. 100 ] Default: 10 Example: limit=10 Page limit |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
Array of objects | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
| count required | integer (Count) Page entries count | ||||||||||||||||||||||||
| currentPage | integer (CurrentPage) >= 0 Deprecated Default: 0 Current page | ||||||||||||||||||||||||
| page required | integer (PageNumber) >= 0 Default: 0 Page number | ||||||||||||||||||||||||
| pageSize | integer (PageSize) [ 1 .. 100 ] Deprecated Default: 10 Page size | ||||||||||||||||||||||||
| limit required | integer (PageLimit) [ 1 .. 100 ] Default: 10 Page limit | ||||||||||||||||||||||||
| total required | integer (TotalCount) >= 0 Default: 0 Total count | ||||||||||||||||||||||||
{- "data": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "text": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b",
- "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
- "mediaIds": [
- "00000000-0000-1000-9000-510d9bb07630"
], - "likeCount": 0,
- "commentCount": 0,
- "likedByUser": true,
- "commentedByUser": true,
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}
], - "count": 10,
- "currentPage": 0,
- "page": 0,
- "pageSize": 10,
- "limit": 10,
- "total": 1000
}✨ Suggest a post
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Get Post Likes
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| page | integer (PageNumber) >= 0 Default: 0 Example: page=0 Page number |
| limit | integer (PageLimit) [ 1 .. 100 ] Default: 10 Example: limit=10 Page limit |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
Array of objects | |||||||||||||
Array
| |||||||||||||
| count required | integer (Count) Page entries count | ||||||||||||
| currentPage | integer (CurrentPage) >= 0 Deprecated Default: 0 Current page | ||||||||||||
| page required | integer (PageNumber) >= 0 Default: 0 Page number | ||||||||||||
| pageSize | integer (PageSize) [ 1 .. 100 ] Deprecated Default: 10 Page size | ||||||||||||
| limit required | integer (PageLimit) [ 1 .. 100 ] Default: 10 Page limit | ||||||||||||
| total required | integer (TotalCount) >= 0 Default: 0 Total count | ||||||||||||
{- "data": [
- {
- "likeId": "00000000-0000-1000-9000-510d9bb07630",
- "postId": "00000000-0000-1000-9000-510d9bb07630",
- "commentId": "00000000-0000-1000-9000-510d9bb07630",
- "likeUserId": "00000000-0000-1000-9000-510d9bb07630",
- "isLiked": true,
- "createdAt": "2024-11-29T12:09:53+00:00"
}
], - "count": 10,
- "currentPage": 0,
- "page": 0,
- "pageSize": 10,
- "limit": 10,
- "total": 1000
}✨ Post like toggling
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| likeId | string <uuid> (LikeId) Like ID |
| postId required | string <uuid> (PostId) Post ID |
| commentId | string <uuid> (CommentId) Comment ID |
| likeUserId required | string <uuid> (LikeUserId) Like User ID |
| isLiked required | boolean |
| createdAt | string <date-time> (DateTime) Date and time in RFC-3339 |
{- "likeId": "00000000-0000-1000-9000-510d9bb07630",
- "postId": "00000000-0000-1000-9000-510d9bb07630",
- "commentId": "00000000-0000-1000-9000-510d9bb07630",
- "likeUserId": "00000000-0000-1000-9000-510d9bb07630",
- "isLiked": true,
- "createdAt": "2024-11-29T12:09:53+00:00"
}✨ Comments of specific Post.
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| page | integer (PageNumber) >= 0 Default: 0 Example: page=0 Page number |
| limit | integer (PageLimit) [ 1 .. 100 ] Default: 10 Example: limit=10 Page limit |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
Array of objects | |||||||||||||||||||||
Array
| |||||||||||||||||||||
| count required | integer (Count) Page entries count | ||||||||||||||||||||
| currentPage | integer (CurrentPage) >= 0 Deprecated Default: 0 Current page | ||||||||||||||||||||
| page required | integer (PageNumber) >= 0 Default: 0 Page number | ||||||||||||||||||||
| pageSize | integer (PageSize) [ 1 .. 100 ] Deprecated Default: 10 Page size | ||||||||||||||||||||
| limit required | integer (PageLimit) [ 1 .. 100 ] Default: 10 Page limit | ||||||||||||||||||||
| total required | integer (TotalCount) >= 0 Default: 0 Total count | ||||||||||||||||||||
{- "data": [
- {
- "commentId": "00000000-0000-1000-9000-510d9bb07630",
- "postId": "00000000-0000-1000-9000-510d9bb07630",
- "commenterUserId": "00000000-0000-1000-9000-510d9bb07630",
- "text": "ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n",
- "likeCount": 0,
- "likedByUser": true,
- "edited": true,
- "createdAt": "2024-11-29T12:09:53+00:00",
- "updatedAt": "2024-11-29T12:09:53+00:00",
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}
], - "count": 10,
- "currentPage": 0,
- "page": 0,
- "pageSize": 10,
- "limit": 10,
- "total": 1000
}✨ Create new Post Comment.
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| text required | string <text> (CommentText) [ 1 .. 2000 ] characters Comment text | ||||
Array of objects (CommentMention) | |||||
Array
| |||||
{- "text": "ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n",
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}{- "id": "00000000-0000-1000-9000-510d9bb07630"
}✨ Get Post Comment.
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| commentId required | string <uuid> (CommentId) Example: 00000000-0000-1000-9000-510d9bb07630 Comment ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| commentId required | string <uuid> (CommentId) Comment ID | ||||
| postId required | string <uuid> (PostId) Post ID | ||||
| commenterUserId required | string <uuid> (CommenterUserId) Commenter User ID | ||||
| text required | string <text> (CommentText) [ 1 .. 2000 ] characters Comment text | ||||
| likeCount required | integer | ||||
| likedByUser required | boolean | ||||
| edited required | boolean | ||||
| createdAt required | string <date-time> (DateTime) Date and time in RFC-3339 | ||||
| updatedAt required | string <date-time> (DateTime) Date and time in RFC-3339 | ||||
Array of objects (CommentMention) | |||||
Array
| |||||
{- "commentId": "00000000-0000-1000-9000-510d9bb07630",
- "postId": "00000000-0000-1000-9000-510d9bb07630",
- "commenterUserId": "00000000-0000-1000-9000-510d9bb07630",
- "text": "ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n",
- "likeCount": 0,
- "likedByUser": true,
- "edited": true,
- "createdAt": "2024-11-29T12:09:53+00:00",
- "updatedAt": "2024-11-29T12:09:53+00:00",
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}✨ Update Post Comment
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| commentId required | string <uuid> (CommentId) Example: 00000000-0000-1000-9000-510d9bb07630 Comment ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| text required | string <text> (CommentText) [ 1 .. 2000 ] characters Comment text | ||||
Array of objects (CommentMention) | |||||
Array
| |||||
{- "text": "ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.\n",
- "mentions": [
- {
- "mentionedUserId": "140e25be-3b54-4b10-8614-005ab1b61fc6",
- "mentionText": "string"
}
]
}{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Delete Post Comment.
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| commentId required | string <uuid> (CommentId) Example: 00000000-0000-1000-9000-510d9bb07630 Comment ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
{- "errors": [
- {
- "code": "validation",
- "message": "string",
- "endpoint": "string",
- "requestId": "string"
}
]
}✨ Get Comment Likes
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| commentId required | string <uuid> (CommentId) Example: 00000000-0000-1000-9000-510d9bb07630 Comment ID |
| page | integer (PageNumber) >= 0 Default: 0 Example: page=0 Page number |
| limit | integer (PageLimit) [ 1 .. 100 ] Default: 10 Example: limit=10 Page limit |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
Array of objects | |||||||||||||
Array
| |||||||||||||
| count required | integer (Count) Page entries count | ||||||||||||
| currentPage | integer (CurrentPage) >= 0 Deprecated Default: 0 Current page | ||||||||||||
| page required | integer (PageNumber) >= 0 Default: 0 Page number | ||||||||||||
| pageSize | integer (PageSize) [ 1 .. 100 ] Deprecated Default: 10 Page size | ||||||||||||
| limit required | integer (PageLimit) [ 1 .. 100 ] Default: 10 Page limit | ||||||||||||
| total required | integer (TotalCount) >= 0 Default: 0 Total count | ||||||||||||
{- "data": [
- {
- "likeId": "00000000-0000-1000-9000-510d9bb07630",
- "postId": "00000000-0000-1000-9000-510d9bb07630",
- "commentId": "00000000-0000-1000-9000-510d9bb07630",
- "likeUserId": "00000000-0000-1000-9000-510d9bb07630",
- "isLiked": true,
- "createdAt": "2024-11-29T12:09:53+00:00"
}
], - "count": 10,
- "currentPage": 0,
- "page": 0,
- "pageSize": 10,
- "limit": 10,
- "total": 1000
}✨ Comment like toggling
| groupId required | string <uuid> (GroupId) Example: 00000000-0000-1000-9000-510d9bb07630 Group ID |
| postId required | string <uuid> (PostId) Example: 00000000-0000-1000-9000-510d9bb07630 Post ID |
| commentId required | string <uuid> (CommentId) Example: 00000000-0000-1000-9000-510d9bb07630 Comment ID |
| traceparent | string^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-... Example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01 W3C Trace Context traceparent header for request tracing |
| x-current-user-id required | string <uuid> Example: 4b72d209-debd-45e1-93cc-7640bf7d39bf Current user ID for authentication and authorization |
| likeId | string <uuid> (LikeId) Like ID |
| postId required | string <uuid> (PostId) Post ID |
| commentId | string <uuid> (CommentId) Comment ID |
| likeUserId required | string <uuid> (LikeUserId) Like User ID |
| isLiked required | boolean |
| createdAt | string <date-time> (DateTime) Date and time in RFC-3339 |
{- "likeId": "00000000-0000-1000-9000-510d9bb07630",
- "postId": "00000000-0000-1000-9000-510d9bb07630",
- "commentId": "00000000-0000-1000-9000-510d9bb07630",
- "likeUserId": "00000000-0000-1000-9000-510d9bb07630",
- "isLiked": true,
- "createdAt": "2024-11-29T12:09:53+00:00"
}