- Returning.AI
- Auth
- Server
- Role
- Channel
- Badge
- Integration
get role list of user on a server
Developing
GET
/roles/{userId}
Request
Path Params
userId
string
required
Example:
1102
Header Params
x-api-key
string
required
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/roles/1102' \
--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": "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
}
]
}