Usage and limits

The usage endpoint, and the limits that do and do not apply to partner API requests.

The usage endpoint¶

GET /api/v1/usage counts the organization's engagements by status.

curl -H "X-API-Key: $PENTR_API_KEY" https://<pentr-host>/api/v1/usage

{
  "organization": "Partner Corp",
  "total_engagements": 3,
  "by_status": {
    "blocked": 2,
    "queued": 1
  }
}

Field	Meaning
`organization`	The organization's name. An organization created when its owner first signed in is named after the owner's email address
`total_engagements`	The number of engagements the organization has, in any status
`by_status`	A count per status. A status with no engagements is absent, not `0`

An organization with no engagements gets "total_engagements": 0 and an empty by_status object. The counts cover every engagement in the organization, whether it was created through the partner API, the console or a schedule.

Limits on requests¶

The partner API applies no rate limit. It has no pagination: every list endpoint returns every matching row in one response. It sets no limit on the size of a request body.

The plan cap¶

The plan tier of the user who created a schedule caps how many engagements the organization may have queued or running when that schedule fires. The cap is checked only then. A partner API submit is not checked against it and can take the organization past the cap; while the count stays at or above the cap, the organization's scheduled occurrences are skipped. See Caps and skips and Plans and limits.

Last updated 2026-09-23