Search for users by query
curl --request GET \
--url https://our-secret-api-url.com/users/searchimport requests
url = "https://our-secret-api-url.com/users/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://our-secret-api-url.com/users/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://our-secret-api-url.com/users/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://our-secret-api-url.com/users/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://our-secret-api-url.com/users/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://our-secret-api-url.com/users/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"id": 123,
"username": "<string>",
"name": "<string>",
"image": "<string>",
"bio": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"currentlyFollowing": true
}
]{
"message": "<string>"
}User
Get Users By Query
Retrieve users based on a search query.
GET
/
users
/
search
Search for users by query
curl --request GET \
--url https://our-secret-api-url.com/users/searchimport requests
url = "https://our-secret-api-url.com/users/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://our-secret-api-url.com/users/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://our-secret-api-url.com/users/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://our-secret-api-url.com/users/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://our-secret-api-url.com/users/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://our-secret-api-url.com/users/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"id": 123,
"username": "<string>",
"name": "<string>",
"image": "<string>",
"bio": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"currentlyFollowing": true
}
]{
"message": "<string>"
}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
Search query for users
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
Unique identifier for the user
Username of the user
Full name of the user
URL of the user's profile image
Biography of the user
Timestamp when the user was verified
Whether the current user is following this user
