Automations

Retrieve automation usage

Read the automation runs consumed in the current period, the plan quota, the reset instant and the warning percentage.

limit: null means no automatic ceiling (Enterprise is by contract).
It is the counter the engine enforces; purging history never changes it.

get/companies/{company}/automations/usage

Request

Base URL: https://api.factuarea.com/v1
URL: https://api.factuarea.com/v1/companies/{company}/automations/usage
Auth: one of:
- HTTP bearer
- API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Factuarea-Versionstring date

Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "consumed": 128,
    "limit": 1000,
    "reset_at": "2026-04-01T00:00:00Z",
    "period": "2026-03",
    "threshold_percent": 80,
    "active_rules": {
      "count": 7,
      "limit": 7
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.