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>'

{
  "users": [
    {
      "custom_user_id": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "last_active_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "has_more": true
}

Users

List Users

List all users in your project with pagination and filtering.

Retrieve all registered users with support for metadata-based filtering and partial user ID search. Results include user activity timestamps and custom metadata.

Query Parameters:

offset (int): Number of records to skip for pagination. Default: 0
limit (int): Maximum records to return. Range: 1-100. Default: 10
metadata_filter (str): JSON string filter for user metadata (supports nested JSON matching)
partial_user_id (str): Partial user ID to search for (case-insensitive)

Returns:

users (List[UserInfo]): List of user objects
total (int): Total number of users matching the filters
has_more (bool): Whether more users are available beyond the current page

GET

api

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>'

{
  "users": [
    {
      "custom_user_id": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "last_active_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "has_more": true
}

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

Show child attributes

total

integer

required

has_more

boolean

required

Create User

Users

Sessions

Merge Conflicts

Memories

List Users

Headers

Query Parameters

Response