Get usage summary for an organization

Returns document workflow counts, monthly send/complete totals, storage usage against plan limits, and metered metrics aggregated from the usage_events ledger for the requested period (default current UTC YYYY-MM). Requires usage:read (or a read API token).

GET/organizations/{organizationSlug}/usage

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Path parameters

organizationSlugstringrequired

Query parameters

periodstring

Usage period key, e.g. 2026-09 (UTC). Defaults to current month.

Responses

200

Usage summary

periodstringrequired

totalDocumentsintegerrequired

workflowCountsobjectrequired

documentsThisMonthintegerrequired

sentThisMonthintegerrequired

completedThisMonthintegerrequired

storageUsedBytesintegerrequired

storageLimitBytesintegerrequired

storagePercentUsednumberrequired

planstringrequired

documentsLimitintegerrequired

documentsPercentUsednumberrequired

completionRateintegerrequired

metricsobjectrequired

Summed quantities by event_type for the period

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

403

Forbidden (insufficient scope or org mismatch)

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationSlugpath*periodqueryUsage period key, e.g. `2026-09` (UTC). Defaults to current month.

Request

curl -X GET "https://api.seal.nyc/api/v1/organizations/string/usage" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.seal.nyc/api/v1/organizations/string/usage", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.seal.nyc/api/v1/organizations/string/usage",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "period": "string",
  "totalDocuments": 0,
  "workflowCounts": {
    "property1": 0,
    "property2": 0
  },
  "documentsThisMonth": 0,
  "sentThisMonth": 0,
  "completedThisMonth": 0,
  "storageUsedBytes": 0,
  "storageLimitBytes": 0,
  "storagePercentUsed": 0,
  "plan": "string",
  "documentsLimit": 0,
  "documentsPercentUsed": 0,
  "completionRate": 0,
  "metrics": {
    "property1": 0,
    "property2": 0
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "title": "string",
  "details": {}
}