specifications/API/client-server/v1/support.md

1.5 KiB

GET /v1/support


Request

No request parameters or request body.


Responses

Status Description
200 Support information for the server.
404 No contact information has been made available.
500 An unhandled error occured.

200 response

Name Type Description
contacts list[Contact] A list of server administators.
support_page string The URL of a webpage that may help users.

Contact

Name Type Description
email_address string Email address for the administrator.
user_id string The local user ID for the administrator in question.
role string Required: A simple description of this responsible for.
{
    "contacts": [
        {
            "email_address": "admin@gorb.app",
            "role": "Main Administrator"
        },
        {
            "email_address": "moderator@gorb.app",
            "user_id": "moderator",
            "role": "Content Moderator"
        }
    ],
    "support_page": "https://help.gorb.app"
}