Get limits and usage

GET /v1/usage

Returns your workspace’s limits, what it has used of them, and the API features on your plan.

Needs usage:read. Counts against the heavy request limit (10 a minute).

Read it when you need it. It shares the heavy request limit (10 a minute) with uploads and with creating templates and broadcasts.

Request

curl https://app.soosh.io/v1/usage \
  -H "Authorization: Bearer $SOOSH_API_KEY"

const res = await fetch('https://app.soosh.io/v1/usage', {
  headers: {
    Authorization: `Bearer ${process.env.SOOSH_API_KEY}`,
  },
});
console.log(await res.json());

import os
import requests

res = requests.get(
    "https://app.soosh.io/v1/usage",
    headers={"Authorization": f"Bearer {os.environ['SOOSH_API_KEY']}"},
)
print(res.json())

Response200

{
  "limits": {
    "api_requests_per_minute": {
      "limit": 600,
      "used": 12
    },
    "api_messages_per_second": {
      "limit": 20
    },
    "contacts": {
      "limit": 10000,
      "used": 812
    },
    "broadcast_messages_per_month": {
      "limit": 50000,
      "used": 1200,
      "period": "2026-10"
    },
    "webhook_endpoints": {
      "limit": 3,
      "used": 1
    },
    "api_keys": {
      "limit": 5,
      "used": 2
    }
  },
  "features": [
    "api.broadcasts",
    "api.chats",
    "api.contacts",
    "api.messages",
    "api.templates",
    "api.templates.manage",
    "webhooks.contacts",
    "webhooks.messages"
  ]
}

Every field of the usage object

Returns

200 The usage object. The workspace’s limits and features.

Errors

Only the ones every request can get.