#LinkCodeDOCS
Docs/Quickstart

Five-minute integration

Live

Resolve your first LinkCode.

Use the public resolver without an API key, handle explicit states and open only destinations selected by the code owner.

01

1. Request a resolution

GET/api/resolve/{code}Live

Codes are case-insensitive. A leading # is accepted and normalized. Unknown codes never guess or silently redirect.

curl https://linkcode-wheat.vercel.app/api/resolve/48327
02

2. Inspect the response

PropertyTypeDescription
codestringrequired

Normalized LinkCode identifier.

statusfound | not_found | unavailable | expiredrequired

Authoritative resolution state.

destinationUrlstring

Owner-selected HTTPS or LinkCode-relative destination when found.

destinationTypedirect | profile | url | media

The resolved destination class.

gateobject

Optional pre-destination experience and delay.

{
  "code": "48327",
  "status": "found",
  "destinationUrl": "/@maya",
  "destinationType": "profile",
  "title": "Maya's creator page"
}
03

3. Handle every state

  • 200 found — the destination is available.
  • 404 not_found — no matching code exists.
  • 410 expired — the code existed and its expiration passed.
  • 423 unavailable — the code exists but is paused, disabled or over its limit.