Get a link

GET/api/links/{id}

Returns one of the app's links and records the call as a click. A link of another app answers 404. A sandbox link's response carries isSandbox: true; other links' responses don't have the field.

Request

Send your app’s API key in the Api-Key header. See Authentication.

Path parameters

idintegerrequired

The link’s id.

Response

200 with this body. For errors, see Errors.

appIdinteger or null

The app the link belongs to.

fullUrlstring or null

The link’s full URL: https://{app}.dev.thedbl.ink plus the path and query you sent.

titlestring or null

As sent.

descriptionstring or null

As sent.

imageUrlstring or null

As sent.

fallbackUrlstring or null

As sent.

customShortCodestring or null

Always null in responses. The code is the last path segment of shortUrl.

idinteger

The link’s id.

shortUrlstring or null

The short URL to share: https://{app}.dev.thedbl.ink/{code}, or on your custom domain when fullUrl used it.

iosBundleIdstring or null

Your app’s iOS bundle ID.

androidPackageNamestring or null

Your app’s Android package name.

isSandboxboolean

true for a sandbox link. Live links’ responses leave the field out.

Example response

{
  "appId": 42,
  "fullUrl": "https://demo.dev.thedbl.ink/products/1234",
  "title": "Spring sale",
  "description": "Up to 50% off this week only.",
  "imageUrl": "https://example.com/images/spring-sale.png",
  "fallbackUrl": "https://example.com/spring-sale",
  "customShortCode": null,
  "id": 1001,
  "shortUrl": "https://demo.dev.thedbl.ink/Xy3kP9aQ",
  "iosBundleId": "com.example.demo",
  "androidPackageName": "com.example.demo"
}

Example

curl

curl -X GET 'https://dev.thedbl.ink/api/links/1001' \
  -H 'Api-Key: YOUR_API_KEY'

Try it

Sends a real request to https://dev.thedbl.ink from your browser. Use your app’s sandbox API key, which starts with sandbox_, while you try things out. Each call records a click on the link.

Api-Keyid

https://dev.thedbl.ink/api/links/%7Bid%7D