---
title: "Get a link's metadata and preview"
method: GET
path: "/links/{id}/metadata"
tags: ["Metadata"]
---

# Get a link's metadata and preview

`GET /links/{id}/metadata`

## Request

- Base URL: `https://fixed.link/api/v1`
- URL: `https://fixed.link/api/v1/links/{id}/metadata`
- Auth: HTTP bearer

Returns what we read from the destination page, your overrides, and the preview a crawler is served. The fetch runs in the background, so a link created moments ago may still be `pending`.

## Path parameters

- `id` string, required

## Response `200`

The link's metadata

- LinkMetadata
  - `status` 'pending' | 'fetching' | 'ok' | 'failed' | 'skipped', required: State of the background fetch of the destination page.
  - `fetched` object, required
    - `title` string, nullable, required
    - `description` string, nullable, required
    - `imageUrl` string, nullable, required
    - `iconUrl` string, nullable, required
    - `siteName` string, nullable, required
    - `author` string, nullable, required
    - `type` string, nullable, required
    - `locale` string, nullable, required
    - `canonicalUrl` string, nullable, required
  - `overrides` object, required
    - `title` string, nullable, required
    - `description` string, nullable, required
    - `imageUrl` string, nullable, required
    - `siteName` string, nullable, required
  - `previewMode` 'auto' | 'custom' | 'off', required
  - `preview` object, nullable, required
    - `title` string, nullable, required
    - `description` string, nullable, required
    - `imageUrl` string, nullable, required
    - `siteName` string, nullable, required
  - `resolvedUrl` string, nullable, required
  - `httpStatus` integer, nullable, required
  - `error` string, nullable, required
  - `fetchedAt` string, date-time, nullable, required

## Other responses

- `404`: No such link

---

[API](https://skmtc.dev/fixed/apis/fixedlink-api.md) · [All operations](https://skmtc.dev/fixed/apis/fixedlink-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fixed/apis/fixedlink-api/revisions/72343453b299?raw)