Get plan usage

GET/api/v2/usage

How much of the plan the workspace has used: storage, sends, AI actions, domains, mailboxes, seats and contacts.

Needs an API key with the newsletter scope. Scopes

Notes

Each figure has used, limit (-1 means unlimited), window and percent.
Needs read.

curl -X GET "https://api.koltrix.com/api/v2/usage" \
  -H "Authorization: Bearer $KOLTRIX_API_KEY"

const res = await fetch("https://api.koltrix.com/api/v2/usage", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.KOLTRIX_API_KEY}`,
  },
});

console.log(res.status, await res.json());

import os, requests

res = requests.get(
    "https://api.koltrix.com/api/v2/usage",
    headers={
        "Authorization": f"Bearer {os.environ['KOLTRIX_API_KEY']}",
    },
)
print(res.status_code, res.json())

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.koltrix.com/api/v2/usage", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KOLTRIX_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

<?php

$ch = curl_init("https://api.koltrix.com/api/v2/usage");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("KOLTRIX_API_KEY"),
    ],
]);

$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response;

Success.

{
  "plan": "growth",
  "trial": false,
  "storage": {
    "used": 1288490188,
    "limit": 53687091200,
    "percent": 2
  },
  "api_sends_daily": {
    "used": 140,
    "limit": -1,
    "window": "day",
    "percent": 0
  },
  "api_sends_monthly": {
    "used": 3120,
    "limit": 50000,
    "window": "month",
    "percent": 6
  },
  "mailboxes": {
    "used": 4,
    "limit": 10,
    "percent": 40
  },
  "seats": {
    "used": 3,
    "limit": 5,
    "percent": 60
  }
}

The API key is missing, malformed, unknown or revoked.

{
  "error": "invalid or revoked api key"
}

The key is valid but does not have the newsletter scope.

{
  "error": "missing permission: newsletter"
}

More than 60 requests a minute on this key. Wait Retry-After seconds. No code field.

Retry-After: 60

{
  "error": "rate limit exceeded — 60 requests per minute per API key"
}

Try it below with your own key. Every sample reads the key from KOLTRIX_API_KEY.

Try it

Send this request from your browser.

Input

What you send

API key

Stays in this browser tab (sessionStorage) and goes only to api.koltrix.com. Create one under Settings → API keys.

Requests are real. Koltrix has no test mode, so use a dedicated key with only the permissions you need and revoke it when you are done.

GEThttps://api.koltrix.com/api/v2/usage

Output

What comes back

The response appears here.
Press Send request.