Get token balance for the authenticated user

GET

/v1/balance

Returns the current token balance associated with the authenticated user.
This endpoint is read‑only and does not consume tokens.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

🟢200

application/json

Balance successfully retrieved.

Body

🟠401

🟠403

🟠429

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sherlockeye.io/v1/balance' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Typical balance response

{
    "success": true,
    "data": {
        "tokens": 1200
    }
}

Modified at 2026-03-04 16:42:25