User-related API environment
Production user-related API docs
These pages describe the Production user-related API stack.
Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.
Need to test before going live? Switch to the Pre-live docs using the environment switcher above.
Get logged-in user rooms
Retrieve all rooms (groups and pages) the authenticated user is a member of. Supports filtering by name and pagination.
Query Parameters
name string
Filter rooms by name
page number
Page number (default: 1)
limit number
Rooms per page (default: 10)
Responses
- 200
- 401
User rooms with pagination metadata
application/json
Schema
Example (from schema)
Example
Schema
- Array [
- ]
total number required
currentPage number required
limit number required
pages number required
data object[] required
id number required
name string required
group string required
privacy string required
Possible values: [public, closed, private]
roomType string required
verified boolean required
subdomain string required
description string required
membersCount number required
avatarUrl object required
small string
medium string
large string
{
"total": 10,
"currentPage": 1,
"limit": 10,
"pages": 1,
"data": [
{
"id": 0,
"name": "string",
"group": "string",
"privacy": "public",
"roomType": "string",
"verified": true,
"subdomain": "string",
"description": "string",
"membersCount": 0,
"avatarUrl": {
"small": "string",
"medium": "string",
"large": "string"
}
}
]
}
{
"total": 10,
"currentPage": 1,
"limit": 10,
"pages": 1,
"data": [
{
"id": 1,
"name": "string",
"group": "string",
"privacy": "public",
"roomType": "string",
"verified": true,
"subdomain": "string",
"description": "string",
"membersCount": 1,
"avatarUrl": {
"small": "string",
"medium": "string",
"large": "string"
}
}
]
}
User not authenticated
Loading...