Get current user
curl --request GET \
--url https://api.example.com/api/v2/meimport requests
url = "https://api.example.com/api/v2/me"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/me', 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.example.com/api/v2/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/api/v2/me"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/api/v2/me")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyAccount
Get current user
Identity + remaining budgets + credit balance + subscription state in one call
GET
/
api
/
v2
/
me
Get current user
curl --request GET \
--url https://api.example.com/api/v2/meimport requests
url = "https://api.example.com/api/v2/me"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/me', 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.example.com/api/v2/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/api/v2/me"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/api/v2/me")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyThe canonical “what can I do right now” endpoint. Verifies your API key AND surfaces every budget the UI needs to render paywall hints.
Request
curl https://www.catchthegoodones.com/api/v2/me \
-H "Authorization: Bearer ctgo_your_api_key_here"
Response
{
"name": "Jane Smith",
"email": "jane@example.com",
"subscriptionStatus": "active",
"isFreeTier": false,
"accounts": [
{
"accountId": 7,
"xHandle": "yongfook",
"tier": "starter",
"monthlyRetest": {
"used": 1,
"budget": 12,
"remaining": 11,
"billingPeriodStart": "2026-05-15T00:00:00Z"
},
"dailySync": { "used": 0, "cap": 1, "remaining": 1 }
}
],
"credits": {
"balance": 47,
"lowBalanceThreshold": 10,
"isLow": false,
"autoTopupEnabled": false
},
"totals": {
"monthlyRetestRemaining": 11,
"dailySyncRemaining": 1
}
}
Response fields
| Field | Type | Description |
|---|---|---|
name | string | User’s display name |
email | string | User’s email |
subscriptionStatus | enum | active, trialing, free_user, past_due, etc. |
isFreeTier | boolean | Convenience flag |
accounts[] | array | Per-account budgets |
accounts[].monthlyRetest | object | Re-test budget for this account, this billing period |
accounts[].dailySync | object | Daily sync slot count for this account |
credits | object | Team credit balance for enrichment |
totals | object | Sum-across-accounts rollup |
Auth
Bearer API key or session cookie.⌘I