Get usage

Credits remaining in each purse and what was spent over a trailing window, by metered action. Inside a client workspace it reports that workspace's spend against the limits the agency set.

GEThttps://app.trygtm.com/api/v1/usage

Scope: read
MCP tool: get_usage

Query parameters

periodstringoptionaldefault: 30d: The trailing window: 7 days, 30 days or 3 months.7d30d3mo

Request

curl -G https://app.trygtm.com/api/v1/usage \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  --data-urlencode "period=30d"

Response

{
  "data": {
    "scope": "organization",
    "period": "30d",
    "since": "2026-08-20T10:00:00.000Z",
    "balance": {
      "data": 12400,
      "action": 5850
    },
    "spent": {
      "data": 1512,
      "action": 2114
    },
    "by_action": [
      {
        "action": "enrich.reveal",
        "label": "Contact reveal",
        "currency": "data",
        "events": 189,
        "quantity": 189,
        "credits": 1512
      }
    ],
    "status": {
      "paused": false,
      "low": false,
      "unlimited": false,
      "reason": null
    }
  }
}