Skip to main content
Groups allow users to be associated with organisations or communities within the DOSS platform. A user can belong to multiple groups. Groups are browsed from the Preferences screen and split into two tabs: groups the user belongs to (My Groups) and all other available groups (Other Groups).
All group endpoints require a valid Bearer token in the Authorization header.

​
List groups

GET /v2/doss_groups Returns all groups categorised into groups the user has joined and groups they have not yet joined.

​
Response

​
mygroups
object[]
Array of groups the authenticated user is currently a member of.
​
othergroups
object[]
Array of groups the authenticated user has not yet joined.
curl https://dossapp.com/api/v2/doss_groups \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

​
Join a group

POST /v2/join_group Adds the authenticated user to a group identified by a 6-digit invite code. The code is entered on the Enter Group Code screen. On success, the groups list cache is invalidated.

​
Request body

​
code
string
required
The 6-digit alphanumeric group invite code.
​
groupId
integer
The numeric ID of the group being joined. Passed from the group list.
curl -X POST https://dossapp.com/api/v2/join_group \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"code": "ABC123", "groupId": 7}'

​
Leave a group

GET /v2/leave_group/:id Removes the authenticated user from the specified group. The user is prompted with a confirmation modal before this endpoint is called. On success, the groups list is refreshed.
Despite being a delete-like operation, this endpoint uses the GET method as implemented in the current client.

​
Path parameters

​
id
integer
required
The numeric ID of the group to leave.

​
Response

​
message
string
A human-readable success message confirming the user has left the group.
curl https://dossapp.com/api/v2/leave_group/7 \
  -H "Authorization: Bearer {token}" \
  -H "Accept: application/json"

Build docs developers (and LLMs) love

Get started for freeTalk to us