List impact limits

Business-impact limits in the caller’s environment, each with its limit, consumed in the current period, reserved (everything held and unresolved, across periods), unknownExposure (the part of reserved whose outcome is unknown or possibly partial, never an additional amount), and available.

GET/api/v2/impact-limits

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Query parameters

includeArchivedstring

Allowed:truefalse

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Impact limits returned.

successbooleanrequired

Allowed:true

dataImpactLimit[]required

Show properties

Array of ImpactLimit

idstringrequired

namestringrequired

dimensionstringrequired

money, resource_mutations, or a workspace-declared unit such as emails.

matches ^[a-z][a-z0-9_]{0,31}$

currencystring | nullrequired

unitstringrequired

What the amounts count. The currency for money, the dimension name for every other dimension.

scopeobjectrequired

Show properties

environmentIdstring<uuid>required

actionNamestring | nullrequired

resourcePrefixstring | nullrequired

periodstringrequired

Allowed:daymonthtotal

limitintegerrequired

min 0

currentPeriodstringrequired

consumedintegerrequired

min 0

reservedintegerrequired

min 0

unknownExposureintegerrequired

min 0

availableintegerrequired

min 0

archivedbooleanrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.includeArchivedquery

Request

curl -X GET 'https://api.anlyon.com/api/v2/impact-limits' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/impact-limits", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/impact-limits",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": [
    {
      "id": "lim_01JABCDEF",
      "name": "string",
      "dimension": "money",
      "currency": "string",
      "unit": "usd",
      "scope": {
        "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
        "actionName": "string",
        "resourcePrefix": "string"
      },
      "period": "day",
      "limit": 0,
      "currentPeriod": "month:2026-09",
      "consumed": 0,
      "reserved": 0,
      "unknownExposure": 0,
      "available": 0,
      "archived": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}