Skip to main content

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

Get joined or managed rooms​

Retrieve rooms the user has joined (joined-rooms) or manages as admin (managed-rooms). Supports search and pagination.

Query Parameters
    query string

    Search query for room names

    page number

    Possible values: >= 1

    Default value: 1

    Page number (default: 1)

    limit number

    Possible values: >= 1 and <= 5

    Default value: 5

    Rooms per page (default: 5)

    sortBy string

    Possible values: [NAME_ASC, NAME_DESC, LATEST_ACTIVITY]

    Sort order (default: NAME_ASC)

Responses

Rooms retrieved with pagination

Schema
    total number required
    currentPage number required
    limit number required
    pages number required
    data object[] required
  • Array [
    • id number required
    name string required
    description string required
    roomType string required
    isActive boolean required
    isVerified boolean required
    isPublic boolean required
    hideFollowJoinButton boolean required
    isOwner boolean required
    isAdmin boolean required
    ownerId string required
    postsCount number required
    membersCount number required
    url string
    avatarUrls object required
    thumb string
    original string
    createdAt date-time
    isMember boolean
    subdomain string
    country string
  • ]
Loading...