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 for users​

Search users by name or username. Supports mentioning in posts, finding users for room invites, and general discovery. Results can be scoped to specific contexts.

Query Parameters
    query string

    Search term for name/username

    limit number

    Results per page (default: 10)

    page number

    Page number (default: 1)

    all boolean

    Search all users (not just followed)

    postingAs boolean

    Filter for posting-as feature

    postingAsUserId string

    User ID for posting-as context

    roomId number

    Room ID for scoped search

Responses

Matching users with pagination

Schema
    total number required
    currentPage number required
    limit number required
    pages number required
    data object[] required
  • Array [
    • id string required
    username string
    verified boolean

    Default value: false

    firstName string
    lastName string
    avatarUrls object required
    followersCount number

    Default value: 0

    bio string
    isFollowed boolean required
    followed boolean
  • ]
Loading...