Skip to main content

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.

Search rooms​

Search for discoverable Public or Closed groups and Public pages by name or description. Results can be filtered by room type.

Query Parameters
    query string

    Search term for room name/description

    page number

    Page number (default: 1)

    limit number

    Results per page (default: 10)

    roomType string

    Filter by room type: GROUP or PAGE

Responses

Matching rooms with pagination

Schema
    total number required
    currentPage number required
    limit number required
    pages number required
    data object[] required
  • Array [
    • isPublic boolean deprecated

    Deprecated content-visibility projection. Use privacy instead.

    id number required
    name string required
    description string required
    roomType string required
    isActive boolean required
    isVerified boolean required
    privacy string required

    Possible values: [public, closed, private]

    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
    membershipRequestStatus string

    Possible values: [none, pending]

    pendingMembershipRequestsCount number
  • ]
Loading...