{
"success": true,
"data": {
"instance": "example.com",
"client_id": "csid_3f9a1c0e7b2d4a6f8e1c5b09",
"mode": "live",
"plan": "pro",
"rate_limit_rps": 10,
"websockets": true,
"global_scope": false,
"users_with_data": 128,
"features": ["callouts"]
},
"meta": {
"request_id": "req_5162c7cf7f87",
"cached": false,
"cache_age_seconds": 0,
"version": "v1",
"timestamp": "2026-10-13T08:04:11Z"
}
}
Users
Me
GET /v1/me: the instance your API key works with, its plan, request rate, how many users you receive data for and the extras switched on for it.
{
"success": true,
"data": {
"instance": "example.com",
"client_id": "csid_3f9a1c0e7b2d4a6f8e1c5b09",
"mode": "live",
"plan": "pro",
"rate_limit_rps": 10,
"websockets": true,
"global_scope": false,
"users_with_data": 128,
"features": ["callouts"]
},
"meta": {
"request_id": "req_5162c7cf7f87",
"cached": false,
"cache_age_seconds": 0,
"version": "v1",
"timestamp": "2026-10-13T08:04:11Z"
}
}
The instance your API key works with, its mode and plan, the request rate, how many users you currently receive data for and which extras are switched on. Call it first to check that your key is set up.

