Link Details

Retrieve metadata and configuration for an existing link

GEThttps://sdk.sqd.link/api/v1/sdk/link/:link_path

Fetch the full details of a link using its unique path identifier.

Replace :link_path with the link's unique path (e.g., 2c1e79). Links created in the test environment carry a -test suffix on their path (e.g., 2c1e79-test); pass it as is. The path is looked up within the environment named by the ENVIRONMENT header.

Headers

PROJECT-KEYstringrequired

Your SDK project key. Found in Dashboard → Developer → API Key.

ENVIRONMENTstringrequired

Target environment. Use production or test. Any other value returns 400.

Content-Typestringoptional

Not needed; the request has no body.

Path Parameters

link_pathstringrequired

The unique path segment of the link you want to retrieve. This is the part after the last / in the link URL.

No request body is required.

Request Example

Bash

curl -X GET https://sdk.sqd.link/api/v1/sdk/link/ef5006 \
  -H "PROJECT-KEY: testpr_86a440d502ee6805ea4f0fabf4dc12afxxxxxxxx" \
  -H "ENVIRONMENT: production" \
  -H "Content-Type: application/json"

Response

JSON

{
  "link": {
    "id": 50510,
    "title": "Summer Sale",
    "subtitle": "50% off all items",
    "path": "ef5006",
    "access_path": "https://grov3cf9.sqd.link/ef5006",
    "updated_at": "2025-05-02T12:43:53.604Z",
    "generated_from_platform": "API",
    "data": {
      "screen": "promo",
      "promo_id": "123"
    },
    "sdk_generated": true,
    "tags": ["campaign", "summer"],
    "active": true,
    "tracking_campaign": "summer_2025",
    "tracking_source": "instagram",
    "tracking_medium": "social",
    "show_preview_ios": true,
    "show_preview_android": null,
    "copy_to_clipboard_ios": null,
    "copy_to_clipboard_android": null,
    "image": null,
    "ios_custom_redirect": {
      "url": "https://example.com/ios",
      "open_app_if_installed": true
    },
    "android_custom_redirect": {
      "url": "https://example.com/android",
      "open_app_if_installed": true
    },
    "desktop_custom_redirect": {
      "url": "https://example.com/desktop",
      "open_app_if_installed": false
    }
  }
}

Response Fields

Link Object

idinteger

Internal link identifier.

titlestring

Link preview title.

subtitlestring

Link preview subtitle.

pathstring

Unique path segment used in the link URL.

access_pathstring

Full URL to access or share the link.

dataobject

Custom metadata attached to the link.

tagsarray

Tags used for categorization and filtering.

activeboolean

Whether the link is currently active.

sdk_generatedboolean

true if the link was created via API or SDK.

generated_from_platformstring

Platform that created the link (e.g., "API", "iOS", "Android").

updated_atstring

ISO 8601 timestamp of the last modification.

Preview & Redirects

show_preview_iosboolean | null

Whether the link shows the preview page on iOS. null means it inherits the project's redirect rule.

show_preview_androidboolean | null

Same, for Android.

copy_to_clipboard_iosboolean | null

Whether the iOS preview page copies the link to the clipboard. null inherits the project setting. See Copy to Clipboard.

copy_to_clipboard_androidboolean | null

Same, for Android.

imagestring | null

Preview image URL, if set.

ios_custom_redirectobject

iOS redirect configuration with url and open_app_if_installed.

android_custom_redirectobject

Android redirect configuration with url and open_app_if_installed.

desktop_custom_redirectobject

Desktop browser fallback with url.

Tracking

tracking_campaignstring | null

Campaign name.

tracking_sourcestring | null

Traffic source.

tracking_mediumstring | null

Campaign medium.

Notes

Use this endpoint to retrieve link metadata dynamically for reporting, routing, or validation logic.

Keep your PROJECT-KEY secure. If you need to regenerate it, contact us at [email protected].

Edit this page on GitHubLast updated 2026-10-07