Skip to main content
GET
/
v1
/
quota
Get document quota and usage
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.factify.com/v1/quota', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "limit": 1000,
  "used": 150,
  "remaining": 850,
  "resets_at": "2025-02-01T00:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication using a factapi-issued API key (ffy_<env>_<base32_uuid><base62_random>). Cookie-based sessions are accepted automatically by user-facing endpoints but are not surfaced as an OpenAPI auth scheme.

Response

Current quota and usage for the caller's organisation.

Document quota and usage for the caller's organization.

​
limit
integer<int64>
required

Document limit for the organization.

Example:

1000

​
used
integer<int64>
required

Current document count for the organization.

Example:

150

​
remaining
integer<int64>
required

Documents remaining (limit - used, floored at 0).

Example:

850

​
resets_at
string<date-time>
required

Next reset timestamp (start of the next month).

Example:

"2025-02-01T00:00:00Z"