Returning.AI
  1. Server
Returning.AI
  • Returning.AI
    • Auth
      • register
      • verify email
      • login
      • secure auth
    • Server
      • create new server
        POST
      • get my servers
        GET
      • update server
        PUT
      • role list of server
        GET
      • channel list of server
        GET
    • Role
      • create new role
      • update role
      • delete role
      • add role to a user on a server
      • remove role from a user on a server
      • get role list of user on a server
    • Channel
      • get channels list
      • create new channel
      • update channel
      • delete channel
    • Badge
      • get badges list
      • create new badge
      • update badge
      • delete badge
      • award badge to user
      • remove badge from user
    • Integration
      • users
        • create new user
      • Messages
        • Send Message
        • Reply Message
      • Channels
        • Get Channels List
  1. Server

role list of server

Developing
GET
/servers/roles

Request

Header Params
x-api-key
string 
required
Example:
**********

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rai-api.returning.ai/api/v1/servers/roles' \
--header 'x-api-key: **********'

Responses

🟢200Success
application/json
Body
meta
object 
required
success
boolean 
required
message
string 
required
devMessage
string 
required
body
array [object {12}] 
required
_id
string 
optional
order
integer 
optional
billable
boolean 
optional
title
string 
optional
description
string 
optional
serverPermissions
object 
optional
channelPermissions
object 
optional
class
string 
optional
serverId
string 
optional
createdAt
string 
optional
updatedAt
string 
optional
__v
integer 
optional
Example
{
    "meta": {
        "success": true,
        "message": "Roles list of server",
        "devMessage": "Roles list of server"
    },
    "body": [
        {
            "_id": "{_id}",
            "order": 1,
            "billable": true,
            "title": "Manager 2",
            "description": "Role with permissions to moderate the server",
            "serverPermissions": {
                "allow_dm": true,
                "create_invite": true,
                "kick_members": true,
                "ban_members": true,
                "manage_roles": true,
                "manage_channels": true,
                "server_administrator": true,
                "warn_members": true,
                "suspend_members": true,
                "broadcast_messages": true,
                "overwrite_language_settings": true,
                "_id": "{_id}"
            },
            "channelPermissions": {
                "view_message_history": true,
                "manage_messages": true,
                "allow_mentions": true,
                "post_messages": true,
                "post_analysis": true,
                "attach_files": true,
                "delete_messages": true,
                "_id": "{_id}"
            },
            "class": "red",
            "serverId": "{_id}",
            "createdAt": "2025-04-30T04:59:35.766Z",
            "updatedAt": "2025-04-30T04:59:35.766Z",
            "__v": 0
        }
    ]
}
Previous
update server
Next
channel list of server