> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.agentphone.ai/api-reference/usage/get-usage-v-1-usage-get/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.agentphone.ai/_mcp/server. # Get Usage GET https://api.agentphone.ai/v1/usage Get usage statistics for the current account. Returns: - Phone number limits (used/limit/remaining) - Message statistics (total, last 24h, last 7 days, last 30 days) - Call statistics (total, last 24h, last 7 days, last 30 days) - Webhook delivery statistics Reference: https://docs.agentphone.ai/api-reference/usage/get-usage-v-1-usage-get ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Response ### 200 Successful Response - `reportGeneratedAt` (string, required) - `numbers` (NumberLimits, required) - `stats` (UsageStats, required) - `periodStart` (string, required) - `periodEnd` (string, required) ## Types ### NumberLimits - `used` (integer, required) - `limit` (integer, required) - `remaining` (integer, required) ### UsageStats - `totalMessages` (integer, required) - `messagesLast24h` (integer, required) - `messagesLast7d` (integer, required) - `messagesLast30d` (integer, required) - `totalCalls` (integer, required) - `callsLast24h` (integer, required) - `callsLast7d` (integer, required) - `callsLast30d` (integer, required) - `totalWebhookDeliveries` (integer, required) - `successfulWebhookDeliveries` (integer, required) - `failedWebhookDeliveries` (integer, required) - `smsSegmentsLast30d` (integer, optional, default: 0) ## Examples **Response** ```json { "reportGeneratedAt": "string", "numbers": { "used": 1, "limit": 1, "remaining": 1 }, "stats": { "totalMessages": 1, "messagesLast24h": 1, "messagesLast7d": 1, "messagesLast30d": 1, "totalCalls": 1, "callsLast24h": 1, "callsLast7d": 1, "callsLast30d": 1, "totalWebhookDeliveries": 1, "successfulWebhookDeliveries": 1, "failedWebhookDeliveries": 1, "smsSegmentsLast30d": 0 }, "periodStart": "string", "periodEnd": "string" } ``` **SDK Code** ```python import requests url = "https://api.agentphone.ai/v1/usage" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.agentphone.ai/v1/usage'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.agentphone.ai/v1/usage" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.agentphone.ai/v1/usage") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.agentphone.ai/v1/usage") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.agentphone.ai/v1/usage', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.agentphone.ai/v1/usage"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentphone.ai/v1/usage")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```