Reference docs
for the machine‑auth
link API.
Operator-first surface for API-key auth, endpoint behavior, request schemas, error codes, and same-origin live testing.
Read current API usage
Read current-month API usage, plan limit, reset date, and API key counts.
/api/v1/usageScoped API key
usage:read
Requires an API-enabled paid plan.
`{ data: ... }` with stable error codes on failures
Why this page exists
Returns the current subscription usage snapshot for the organization behind the API key, including rate limit tier and active key counts for portal and automation tooling.
Headers
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization | string | Optional | Preferred authentication header. Send a scoped API key using the Bearer scheme. | Bearer 1gt_live_1234567890abcdef |
X-API-Key | string | Optional | Alternative authentication header. Use this only when Authorization headers are difficult to inject. | 1gt_live_1234567890abcdef |
X-Request-Id | string | Optional | Optional caller-provided correlation ID. When omitted, 1get generates one and echoes it back in responses. | req_a1f7f4bf |
Request discipline
- Call this endpoint when you want to surface quota state in tooling or before launching larger automation batches.
- The usage meter is subscription-level. Per-key request history remains a portal concern, not an external public contract.
- This read lane is lighter than shorten, but still rate-limited and metered.
- Polling it on every request is unnecessary. Cache it inside your worker or client for a short interval.
- API_SCOPE_FORBIDDEN means the key does not include usage:read.
- SUBSCRIPTION_INACTIVE and API_ACCESS_DISABLED indicate the organization is no longer eligible for machine access.
Create or rotate keys from the authenticated portal
Use the dashboard portal when you need scoped key lifecycle management, entitlement visibility, and request activity history.
Read current API usage
Read current-month API usage, plan limit, reset date, and API key counts.
/api/v1/usageScoped API key
usage:read
Requires an API-enabled paid plan.
`{ data: ... }` with stable error codes on failures
Why this page exists
Returns the current subscription usage snapshot for the organization behind the API key, including rate limit tier and active key counts for portal and automation tooling.
Headers
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization | string | Optional | Preferred authentication header. Send a scoped API key using the Bearer scheme. | Bearer 1gt_live_1234567890abcdef |
X-API-Key | string | Optional | Alternative authentication header. Use this only when Authorization headers are difficult to inject. | 1gt_live_1234567890abcdef |
X-Request-Id | string | Optional | Optional caller-provided correlation ID. When omitted, 1get generates one and echoes it back in responses. | req_a1f7f4bf |
Request discipline
- Call this endpoint when you want to surface quota state in tooling or before launching larger automation batches.
- The usage meter is subscription-level. Per-key request history remains a portal concern, not an external public contract.
- This read lane is lighter than shorten, but still rate-limited and metered.
- Polling it on every request is unnecessary. Cache it inside your worker or client for a short interval.
- API_SCOPE_FORBIDDEN means the key does not include usage:read.
- SUBSCRIPTION_INACTIVE and API_ACCESS_DISABLED indicate the organization is no longer eligible for machine access.
Create or rotate keys from the authenticated portal
Use the dashboard portal when you need scoped key lifecycle management, entitlement visibility, and request activity history.
Move from docs into plans, portal access, and product context
Use the surrounding public surfaces to compare plan lanes, see the developer bridge page, or move into the authenticated API Access portal when you are ready to create real keys.
Positioning, API summary, privacy-first analytics, Bitly-alternative framing, and pricing overview.
Public developer bridge page with API-key auth model, request shapes, QR support, and upgrade path.
Long-form technical guides for Next.js, Python, AI agents, automations, and Bitly migration flows built around the public API surface.
Plan ladder for Free, Basic, Business, and Enterprise with API-adjacent positioning and FAQ.
Partner-program overview for agencies, creators, consultants, and technical partners.
Comparison page for developers evaluating 1get vs Bitly on API approach, speed, privacy, and auditability.
How developers, consultancies, marketing teams, and content creators use 1get — API automation, link analytics, and multi-client workspaces.