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 a link record
Read a single link record owned by the API key organization.
/api/v1/links/{id}Scoped API key
links:read
Requires an API-enabled paid plan.
`{ data: ... }` with stable error codes on failures
Why this page exists
Returns a stable developer-friendly link contract. Lookups are always scoped to the authenticated organization and never trust caller-provided tenant IDs.
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
- Provide the UUID path parameter exactly as returned by the shorten response.
- links:read is enough for metadata retrieval; write scopes are not required.
- GET reads still consume api_calls from the current billing window.
- High-volume polling is usually the wrong pattern; store ids and fetch only when state matters.
- NOT_FOUND means the link does not exist or is not owned by the key's organization.
- API_SCOPE_FORBIDDEN means the key does not include links: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 a link record
Read a single link record owned by the API key organization.
/api/v1/links/{id}Scoped API key
links:read
Requires an API-enabled paid plan.
`{ data: ... }` with stable error codes on failures
Why this page exists
Returns a stable developer-friendly link contract. Lookups are always scoped to the authenticated organization and never trust caller-provided tenant IDs.
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
- Provide the UUID path parameter exactly as returned by the shorten response.
- links:read is enough for metadata retrieval; write scopes are not required.
- GET reads still consume api_calls from the current billing window.
- High-volume polling is usually the wrong pattern; store ids and fetch only when state matters.
- NOT_FOUND means the link does not exist or is not owned by the key's organization.
- API_SCOPE_FORBIDDEN means the key does not include links: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.