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.
Fetch QR metadata for a link
Read QR metadata for a link owned by the authenticated organization.
/api/v1/links/{id}/qrScoped API key
qr:read
Requires an API-enabled paid plan.
`{ data: ... }` with stable error codes on failures
Why this page exists
Returns the absolute QR asset URL plus format and styling metadata. This endpoint is useful when an integration needs the QR details without re-fetching the full link payload.
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 |
Path parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Required | 1get link UUID. | ecb3ec1f-ae2e-4c30-b7d6-c47b4c671f7b |
Request discipline
- Use the same link UUID returned by shorten or stored from prior calls.
- This route is useful when your UI needs QR details without re-fetching the whole link object.
- QR metadata reads count toward api_calls like other external routes.
- If you already have qr_code metadata from a recent shorten response, prefer caching that value instead of re-reading immediately.
- NOT_FOUND means the QR record is not available for that link in the current organization.
- API_SCOPE_FORBIDDEN means the key does not include qr:read.
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.
Fetch QR metadata for a link
Read QR metadata for a link owned by the authenticated organization.
/api/v1/links/{id}/qrScoped API key
qr:read
Requires an API-enabled paid plan.
`{ data: ... }` with stable error codes on failures
Why this page exists
Returns the absolute QR asset URL plus format and styling metadata. This endpoint is useful when an integration needs the QR details without re-fetching the full link payload.
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 |
Path parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Required | 1get link UUID. | ecb3ec1f-ae2e-4c30-b7d6-c47b4c671f7b |
Request discipline
- Use the same link UUID returned by shorten or stored from prior calls.
- This route is useful when your UI needs QR details without re-fetching the whole link object.
- QR metadata reads count toward api_calls like other external routes.
- If you already have qr_code metadata from a recent shorten response, prefer caching that value instead of re-reading immediately.
- NOT_FOUND means the QR record is not available for that link in the current organization.
- API_SCOPE_FORBIDDEN means the key does not include qr:read.
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.