Skip to main content
GET
Search users

Authorizations

Authorization
string
header
required

Clerk session token. Use Authorization: Bearer .

Query Parameters

q
string
required
Minimum string length: 1
Pattern: .*\S.*
page
integer
default:1
Required range: x >= 1
limit
integer
default:20

Page size. Accepted; typeaheads should send their visible row count (e.g. 6) instead of slicing a full page client-side.

Required range: 1 <= x <= 50
scope
enum<string>

Omit for the default explore search. mention matches handle and name only.

Available options:
mention

Response

{ success, data: { users, total, page, totalPages, query } }

success
enum<boolean>
required
Available options:
true
data
object
required