Search Users

Search users within a project by partial ID or saved display name.

GET/v2/projects/{project_id}/users/search

Authorization

Bearer TokenRequired

Path Parameters

project_idstringRequired

The unique identifier of the project.

Query Parameters

searchstringRequired

Case-insensitive partial match against user ID or name fragments. Minimum 3 characters.

limitintegerDefault: 10

Maximum number of items per page.

offsetintegerDefault: 0

Number of items to skip before returning results.

Request

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/users/search?search=john&limit=10" \
  -H "Authorization: Bearer YOUR_TOKEN"

const project_id = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/users/search?search=john&limit=10`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/users/search',
    params={'search': 'john', 'limit': 10},
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/users/search?search=john&limit=10");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Successapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/users/search",
  "code": 200,
  "total": 2,
  "limit": 10,
  "offset": 0,
  "message": "Users retrieved successfully",
  "data": [
    {
      "user_id": "123456789012345678",
      "user_first_seen": "2025-01-15T10:30:00.000Z",
      "user_last_seen": "2025-01-20T14:00:00.000Z",
      "is_admin": false,
      "is_banned": false,
      "user_name": {
        "first_name": "John",
        "username": "johndoe"
      },
      "balance": "0",
      "currency": "USD"
    },
    {
      "user_id": "234567890123456789",
      "user_first_seen": "2025-01-10T08:15:00.000Z",
      "user_last_seen": "2025-01-18T18:30:00.000Z",
      "is_admin": false,
      "is_banned": false,
      "user_name": {
        "first_name": "Johnny",
        "username": "johnny_a"
      },
      "balance": "10.00",
      "currency": "USD"
    }
  ]
}

Last updated: January 15, 2026

API Endpoint

Search Users

Authorization

Path Parameters

Query Parameters