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

1 KiB

GET /api/v1/community/{id}

Requires an authentication header

Returns a community with id = {id}

Response:

{
    "id": "string",
    "name": "string"
}

GET /api/v1/community/{id}/members

Requires an authentication header

Returns users for a community with id = {id}

Response:

{
    "id": "string",
    "name": "string",
    "members": [
        {
            "id": "string",
            "username": "string"
        }
    ]
}

GET /api/v1/community/{id}/channels

Requires an authentication header

Returns channels for a community with id = {id}

Response:

{
    "id": "string",
    "name": "string",
    "channels": [
        {
            "id": "string",
            "name": "string"
        }
    ]
}

GET /api/v1/community/{id}/roles

Requires an authentication header

Returns roles for a community with id = {id}

Response:

{
    "id": "string",
    "name": "string",
    "roles": [
        {
            "id": "string",
            "name": "string"
        }
    ]
}