nexlink/docs/api/community.md
2025-12-23 14:45:41 -05:00

65 lines
1 KiB
Markdown

## GET /api/v1/community/{id}
*Requires authentication header*
Returns a community with id = {id}
### Response:
```json
{
"id": "string",
"name": "string"
}
```
## GET /api/v1/community/{id}/members
*Requires authentication header*
Returns users for a community with id = {id}
### Response:
```json
{
"id": "string",
"name": "string",
"members": [
{
"id": "string",
"username": "string"
}
]
}
```
## GET /api/v1/community/{id}/channels
*Requires authentication header*
Returns channels for a community with id = {id}
### Response:
```json
{
"id": "string",
"name": "string",
"channels": [
{
"id": "string",
"name": "string"
}
]
}
```
## GET /api/v1/community/{id}/roles
*Requires authentication header*
Returns roles for a community with id = {id}
### Response:
```json
{
"id": "string",
"name": "string",
"roles": [
{
"id": "string",
"name": "string"
}
]
}
```