Returning.AI
  1. Role
Returning.AI
  • Returning.AI
    • APIs
      • Authentication
      • System API
        • Auth
          • Secure Auth
          • register
          • verify email
          • login
        • Server
          • create new server
          • get my servers
          • update server
          • role list of server
          • channel list of server
        • Channel
          • get channels list
          • create new channel
          • update channel
          • delete channel
        • Role
          • create new role
            POST
          • update role
            PUT
          • delete role
            DELETE
          • add role to a user on a server
            POST
          • remove role from a user on a server
            POST
          • get role list of user on a server
            GET
        • Badge
          • get badges list
          • create new badge
          • update badge
          • delete badge
          • award badge to user
          • remove badge from user
      • Application API
        • Community Users
          • Get community users
          • Get user
        • User Fields
          • Get All User Fields
          • Get specific user field
          • Create Custom User Field
          • Update user field
          • Delete user field
        • User Field Histories
          • Get all user field histories in a community
          • Get user field histories for a specific field
          • Get user field histories for a specific user
          • Get user field histories of specific user field and user
          • Create user field history for specific user
      • Integration API
        • Users
          • Get Users with Filters
          • Create New User
          • Get User Data
          • Manage User Account
          • Get User Gamification History
          • Get User Gamification Stats
          • Bulk Import
          • Bulk Update
        • Messages
          • Send Message
          • Reply Message
          • React Message
        • Channels
          • Get Channels List
      • User API
        • API key
          • api key info
          • Get User Api Key
          • Post User Api Key
          • Update User Api Key
          • Delete Endpoint
        • Messages
          • Send Message
          • Reply Message
          • React Message
    • Channels
      • Iframe
    • Events
      • Outgoing webhooks
        • Encryption
        • User Joins Server
        • User Visits server
        • New Message Posted Anywhere
        • New Message Posted To channel
        • Purchased Store Item
      • Incoming webhooks
        • API Keys & Encryption
        • Send message into channels
        • Update Custom User Fields
        • Update In-game currency
    • Widgets
      • Channels
      • Leaderboard
      • Milestone
      • Socials
      • Store
  1. Role

get role list of user on a server

Developing
GET
/roles/{userId}

Request

Path Params

Header Params

Request Code 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/roles/1102' \
--header 'x-api-key;'

Responses

🟢200Success
application/json
Body

Example
{
    "meta": {
        "success": true,
        "message": "User roles fetched successfully",
        "devMessage": "User roles fetched successfully"
    },
    "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
            },
            "channelPermissions": {
                "view_message_history": true,
                "manage_messages": true,
                "allow_mentions": true,
                "post_messages": true,
                "post_analysis": true,
                "attach_files": true,
                "delete_messages": true
            },
            "class": "red",
            "serverId": "{_id}",
            "createdAt": "2025-04-30T08:48:49.094Z",
            "updatedAt": "2025-04-30T08:48:49.094Z",
            "__v": 0
        }
    ]
}
Modified at 2025-05-22 06:02:43
Previous
remove role from a user on a server
Next
get badges list