Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://dashboard.researchanddesire.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://dashboard.researchanddesire.com/api/v1/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://dashboard.researchanddesire.com/api/v1/users', 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://dashboard.researchanddesire.com/api/v1/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://dashboard.researchanddesire.com/api/v1/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://dashboard.researchanddesire.com/api/v1/users")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://dashboard.researchanddesire.com/api/v1/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "ok": true,
  "data": {
    "data": [
      {
        "id": 42,
        "username": "alice_trainer",
        "accountType": "user",
        "subscriptionTier": "ultra",
        "league": 3,
        "rank": 150,
        "totalPoints": 12500,
        "matchPoints": 800,
        "profileImage": "https://example.com/avatar.jpg",
        "profileDescription": "Hello world",
        "profileTitle": "Expert Trainer"
      }
    ],
    "pagination": {
      "limit": 50,
      "offset": 0
    }
  }
}
{
  "ok": false,
  "error": "Unauthorized"
}
{
  "ok": false,
  "error": "Internal server error"
}

Authorizations

​
Authorization
string
header
required

API tokens can be created in the Dashboard settings. Requires an Ultra subscription.

Query Parameters

​
limit
integer
default:50

Number of records to return (default 50, max 100)

Required range: 1 <= x <= 100
Example:

50

​
offset
integer
default:0

Number of records to skip (default 0)

Required range: x >= 0
Example:

0

Response

List of users

​
ok
boolean
required
​
data
object
required