Skip to main content
GET
/
api
/
v1
/
users
List Users
curl --request GET \
  --url https://api.recallrai.com/api/v1/users \
  --header 'X-Recallr-Api-Key: <x-recallr-api-key>' \
  --header 'X-Recallr-Project-Id: <x-recallr-project-id>'
import requests

url = "https://api.recallrai.com/api/v1/users"

headers = {
"X-Recallr-Project-Id": "<x-recallr-project-id>",
"X-Recallr-Api-Key": "<x-recallr-api-key>"
}

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

print(response.text)
const options = {
method: 'GET',
headers: {
'X-Recallr-Project-Id': '<x-recallr-project-id>',
'X-Recallr-Api-Key': '<x-recallr-api-key>'
}
};

fetch('https://api.recallrai.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://api.recallrai.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 => [
"X-Recallr-Api-Key: <x-recallr-api-key>",
"X-Recallr-Project-Id: <x-recallr-project-id>"
],
]);

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

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

req.Header.Add("X-Recallr-Project-Id", "<x-recallr-project-id>")
req.Header.Add("X-Recallr-Api-Key", "<x-recallr-api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.recallrai.com/api/v1/users")
.header("X-Recallr-Project-Id", "<x-recallr-project-id>")
.header("X-Recallr-Api-Key", "<x-recallr-api-key>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["X-Recallr-Project-Id"] = '<x-recallr-project-id>'
request["X-Recallr-Api-Key"] = '<x-recallr-api-key>'

response = http.request(request)
puts response.read_body
{
  "users": [
    {
      "custom_user_id": "<string>",
      "metadata": {},
      "merge_conflict_enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_active_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "has_more": true
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

X-Recallr-Project-Id
string<uuid>
required
X-Recallr-Api-Key
string
required

Query Parameters

offset
integer
default:0
Required range: x >= 0
limit
integer
default:10
Required range: 1 <= x <= 100
metadata_filter
string | null
partial_user_id
string | null

Response

Users listed successfully

users
UserInfo · object[]
required
total
integer
required
has_more
boolean
required