Skip to main content
GET
/
users
/
search
Search for users by query
curl --request GET \
  --url https://our-secret-api-url.com/users/search
[
  {
    "id": 123,
    "username": "<string>",
    "name": "<string>",
    "image": "<string>",
    "bio": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z",
    "currentlyFollowing": true
  }
]
The property currentlyFollowing will be returned only if userId is passed to the API.
This API is useful for searching users by a partial match on their username.

Query Parameters

​
query
string
required

Search query for users

​
userId
string

Filter results to exclude the user with the specified userId and return include additional property currentFollowing, indicating whether the specified user is following each returned user.

Response

Successful response with user data

​
id
integer<int64>
required

Unique identifier for the user

​
username
string
required

Username of the user

​
name
string
required

Full name of the user

​
image
string
required

URL of the user's profile image

​
bio
string | null
required

Biography of the user

​
verifiedAt
string<date-time> | null
required

Timestamp when the user was verified

​
currentlyFollowing
boolean

Whether the current user is following this user