#The Link object

Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata, letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.

createdAt

string (date-time)

When the link was created.

customDomain

object

Captures a branded hostname that Linkbreakers provisions for a workspace so scans and shortlinks resolve under the customer's domain, including verification and certificate lifecycle state.

customDomainId

string

The ID of the custom domain (UUID). This is the custom domain that is used to access the link. If not defined, the link will be accessed using the default domain.

entrypoint

string

The entrypoint URL This is the URL that is available to be redirected to the destination.

eventCount

string (int64)

The number of time the link has been scanned. This number isn't refreshed instantly but will update itself within a few seconds.

fallbackDestination

string

The fallback destination URL to use when workflow steps are broken

string

The unique identifier of the link (UUID)

leadGoalDefinition

string

The lead goal definition for the link. This is a text field that can be used to describe the lead goal or purpose of the link.

leadTargetDefinition

string

The lead target definition for the link. This is a text field that can be used to describe the target lead criteria for the link.

metadata

object

A map of string key-value pairs. All values must be strings. Nested objects or arrays are not supported. Maximum of 50 keys.

name

string

The name of the link

pageTheme

object

Page theme configuration

pageThemeId

string

The ID of the page theme for this link (UUID).

qrcodeDesign

object

Captures the visual recipe Linkbreakers uses when rendering downloadable QR codes, including colors, shapes, export options, and center media. QR Code Designs are the visual representation of a link. They can be attached to QR Code Templates for reusability. They can only be attached to one record at a time.

qrcodeDesignId

string

The ID of the link design (UUID). This is the ID of the design that is used to generate the QR Code. If not defined, the design from the QR Code template will be used.

qrcodePendingUpdateSince

string (date-time)

When the link is pending QR Code update. This happens when the QR Code Design is updated and the QR Code image is still being processed.

qrcodeSignedUrl

string

The signed URL for the QR Code image. This URL eventually expires.

qrcodeTemplateId

string

The ID of the design template (UUID). This is the template that is used to generate the first QR Code Design assigned to the link. If not defined, a default QR Code Design will be generated.

shortlink

string

The short link for the link. This is the path segment that is attached to the URL. It can be defined by the client or generated by the system but is never null. It is unique within a custom domain or Linkbreakers default domain.

tags

array<object>

The tags associated with the link.

updatedAt

string (date-time)

When the link was last updated.

workspaceId

string

The workspace ID the link belongs to (UUID)

Learn more

Learn more about links in Linkbreakers

Example object

{
  "createdAt": "2026-01-19T17:28:41.458Z",
  "customDomain": {
    "activatedAt": "2026-01-19T17:28:41.458Z",
    "createdAt": "2026-01-19T17:28:41.458Z",
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "lastCheckedAt": "2026-01-19T17:28:41.458Z",
    "name": "example.com",
    "status": "STATUS_ACTIVE",
    "updatedAt": "2026-01-19T17:28:41.458Z",
    "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
  },
  "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "entrypoint": "https://linkbreak.ing/4BnH-R19p",
  "eventCount": 128,
  "fallbackDestination": "https://brand.example.com/fallback",
  "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "leadGoalDefinition": "string",
  "leadTargetDefinition": "string",
  "metadata": {},
  "name": "string",
  "pageTheme": {
    "backgroundColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "string"
    },
    "buttonColor": {
      "colors": [
        "string"
      ],
      "direction": "string",
      "stops": [
        "string"
      ],
      "type": "string"
    },
    "createdAt": "2026-01-19T17:28:41.458Z",
    "id": "string",
    "updatedAt": "2026-01-19T17:28:41.458Z",
    "workspaceId": "string"
  },
  "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "qrcodeDesign": {
    "backgroundOptions": {
      "themeColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      }
    },
    "centralImageMargin": 0,
    "centralImageSignedUrl": "https://example.com",
    "centralImageSize": 0,
    "cornersDotOptions": {
      "themeColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "type": "string"
    },
    "cornersSquareOptions": {
      "themeColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "type": "string"
    },
    "createdAt": "2026-01-19T17:28:41.458Z",
    "dotsOptions": {
      "themeColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "type": "string"
    },
    "errorCorrectionLevel": "string",
    "height": 0,
    "hideBackgroundDots": false,
    "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
    "shape": "SHAPE_SQUARE",
    "updatedAt": "2026-01-19T17:28:41.458Z",
    "width": 0
  },
  "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
  "qrcodePendingUpdateSince": "2026-01-19T17:28:41.458Z",
  "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
  "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
  "shortlink": "4BnH-R19p",
  "tags": [
    {
      "createdAt": "2026-01-19T17:28:41.458Z",
      "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
      "name": "string",
      "updatedAt": "2026-01-19T17:28:41.458Z"
    }
  ],
  "updatedAt": "2026-01-19T17:28:41.458Z",
  "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
}

GET/v1/linksRequires auth

#List links

Retrieves the shortened links for your workspace

#Parameters

query parameters

pageSize

integer (int32)Requiredquery

The maximum number of links to return.

pageToken

stringquery

The token for retrieving the next page of results If not provided, the first page of results will be returned

include

array<string>query

List of related resources to include in the response. Supported values: "customDomain", "qrcodeDesign", "qrcodeSignedUrl", "tags", "pageTheme". Use "qrcodeSignedUrl" to fetch signed QR image URLs—they are omitted by default to keep requests fast.

tags

array<string>query

Tags to filter links by (matches links containing any of the provided tags)

stringquery

Search query to filter links by name or shortlink Search query to filter links by name or shortlink

#Response

200

Everything worked as expected.

links

array<object>

nextPageToken

string

Cursor to fetch the next page of links

totalCount

integer (int64)

Total number of links matching the current filters

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links?pageSize={pageSize}&pageToken={pageToken}&include={include}&tags={tags}&search={search}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "links": [
    {
      "createdAt": "2026-01-19T17:28:41.453Z",
      "customDomain": {
        "activatedAt": "2026-01-19T17:28:41.453Z",
        "createdAt": "2026-01-19T17:28:41.453Z",
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "lastCheckedAt": "2026-01-19T17:28:41.453Z",
        "name": "example.com",
        "status": "STATUS_ACTIVE",
        "updatedAt": "2026-01-19T17:28:41.453Z",
        "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "entrypoint": "https://linkbreak.ing/4BnH-R19p",
      "eventCount": 128,
      "fallbackDestination": "https://brand.example.com/fallback",
      "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "leadGoalDefinition": "string",
      "leadTargetDefinition": "string",
      "metadata": {},
      "name": "string",
      "pageTheme": {
        "backgroundColor": {},
        "buttonColor": {},
        "createdAt": "2026-01-19T17:28:41.453Z",
        "id": "string",
        "updatedAt": "2026-01-19T17:28:41.453Z",
        "workspaceId": "string"
      },
      "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "qrcodeDesign": {
        "backgroundOptions": {},
        "centralImageMargin": 0,
        "centralImageSignedUrl": "https://example.com",
        "centralImageSize": 0,
        "cornersDotOptions": {},
        "cornersSquareOptions": {},
        "createdAt": "2026-01-19T17:28:41.454Z",
        "dotsOptions": {},
        "errorCorrectionLevel": "string",
        "height": 0,
        "hideBackgroundDots": false,
        "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
        "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
        "shape": "SHAPE_SQUARE",
        "updatedAt": "2026-01-19T17:28:41.454Z",
        "width": 0
      },
      "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "qrcodePendingUpdateSince": "2026-01-19T17:28:41.454Z",
      "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
      "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
      "shortlink": "4BnH-R19p",
      "tags": [
        {}
      ],
      "updatedAt": "2026-01-19T17:28:41.454Z",
      "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
    }
  ],
  "nextPageToken": "eyJsaW5rSWQiOiI0YmEifQ==",
  "totalCount": 42
}

Base URL: https://api.linkbreakers.com

GET/v1/links/{id}Requires auth

#Get link details

Retrieves information about a shortened link including its metadata and metrics.

#Parameters

path parameters

stringRequiredpath

The ID of the link to retrieve (UUID)

query parameters

include

array<string>query

#Response

200

Everything worked as expected.

link

object

Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata, letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links/{id}?include={include}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "link": {
    "createdAt": "2026-01-19T17:28:41.457Z",
    "customDomain": {
      "activatedAt": "2026-01-19T17:28:41.457Z",
      "createdAt": "2026-01-19T17:28:41.457Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "lastCheckedAt": "2026-01-19T17:28:41.457Z",
      "name": "example.com",
      "status": "STATUS_ACTIVE",
      "updatedAt": "2026-01-19T17:28:41.457Z",
      "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    },
    "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entrypoint": "https://linkbreak.ing/4BnH-R19p",
    "eventCount": 128,
    "fallbackDestination": "https://brand.example.com/fallback",
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "leadGoalDefinition": "string",
    "leadTargetDefinition": "string",
    "metadata": {},
    "name": "string",
    "pageTheme": {
      "backgroundColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "buttonColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.457Z",
      "id": "string",
      "updatedAt": "2026-01-19T17:28:41.457Z",
      "workspaceId": "string"
    },
    "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {}
      },
      "centralImageMargin": 0,
      "centralImageSignedUrl": "https://example.com",
      "centralImageSize": 0,
      "cornersDotOptions": {
        "themeColor": {},
        "type": "string"
      },
      "cornersSquareOptions": {
        "themeColor": {},
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.457Z",
      "dotsOptions": {
        "themeColor": {},
        "type": "string"
      },
      "errorCorrectionLevel": "string",
      "height": 0,
      "hideBackgroundDots": false,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-01-19T17:28:41.457Z",
      "width": 0
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "qrcodePendingUpdateSince": "2026-01-19T17:28:41.457Z",
    "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
    "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "shortlink": "4BnH-R19p",
    "tags": [
      {
        "createdAt": "2026-01-19T17:28:41.457Z",
        "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
        "name": "string",
        "updatedAt": "2026-01-19T17:28:41.457Z"
      }
    ],
    "updatedAt": "2026-01-19T17:28:41.457Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

GET/v1/links/{linkId}/lead-score-explanation/{eventId}Requires auth

#Get lead score explanation

Generates an AI-powered explanation for a lead score result based on event data.

#Parameters

path parameters

linkId

stringRequiredpath

The ID of the link (UUID)

eventId

stringRequiredpath

The ID of the event for which to generate the explanation (UUID)

#Response

200

Everything worked as expected.

breakdown

object

Breakdown of lead scoring factors

explanation

string

Detailed explanation of how the lead score was calculated

leadScore

integer (int32)

The lead score that was calculated for this event

recurringScans

integer (int32)

Number of recurring scans from this device+link combination

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links/{linkId}/lead-score-explanation/{eventId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "breakdown": {
    "brandSupportiveness": 0,
    "engagementLevel": 0,
    "profileFit": 0,
    "recurringInterest": 0,
    "technologicalAptitude": 0
  },
  "explanation": "string",
  "leadScore": 0,
  "recurringScans": 0
}

Base URL: https://api.linkbreakers.com

GET/v1/links/shortlink-availabilityRequires auth

#Check shortlink availability

Checks if a shortlink is available for use to create a new link. A custom domain can be provided to check against. It typically checks the shortlink slugs and shortlink IDs already present within the system.

#Parameters

query parameters

shortlink

stringquery

The shortlink to check availability for.

customDomainId

stringquery

The ID of the custom domain to check against (UUID) If not provided, checks against the default domain

#Response

200

Everything worked as expected.

available

boolean

Whether the slug is available for use

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links/shortlink-availability?shortlink={shortlink}&customDomainId={customDomainId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "available": false
}

Base URL: https://api.linkbreakers.com

GET/v1/links/shortlink-randomRequires auth

#Get a random shortlink

Generates a random availableshortlink for a new link.

#Parameters

This endpoint does not accept any parameters.

#Response

200

Everything worked as expected.

shortlink

string

Suggested available shortlink slug generated by the service

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X GET "https://api.linkbreakers.com/v1/links/shortlink-random" \
  -H "Authorization: Bearer YOUR_TOKEN"

Typical response

{
  "shortlink": "string"
}

Base URL: https://api.linkbreakers.com

POST/v1/linksRequires auth

#Create a new link

This endpoint allows users to create a new shortened URL link in their Linkbreakers workspace. The URL will be checked for malicious content before being shortened.

#Parameters

This endpoint does not accept any parameters.

#Request body

customDomainId

string

The ID of the custom domain (UUID)

destination

stringRequired

The destination URL to shorten. This field is required.

fallbackDestination

string

The fallback destination URL to use when workflow steps are broken

leadGoalDefinition

string

The lead goal definition for the link. This is a text field that can be used to describe the lead goal or purpose of the link.

leadTargetDefinition

string

The lead target definition for the link. This is a text field that can be used to describe the target lead criteria for the link.

metadata

object

A map of string key-value pairs. All values must be strings. Nested objects or arrays are not supported. Maximum of 50 keys.

name

string

The name of the link

qrcodeDesignId

string

The QR Code design ID (UUID). If you include this value, the specified design will be associated to this link only. A design can belong to one record at a time (Link or QR Code Template). Trying to use a design that's already assigned will cause an error.

qrcodeTemplateId

string

The ID of the QR Code template (UUID) If not given, the default QR Code template will be used to generate the QR Code design.

shortlink

string

The shortlink for the link If not given, the shortlink will be generated by the system.

tags

array<string>

List of tags to associate with the link. If a tag doesn't exist, it will be created.

waitForQrcode

boolean

Wait for QR code generation to complete. Note: This makes the request slower compared to asynchronous generation.

#Response

200

Everything worked as expected.

link

object

Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata, letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/links" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"customDomainId":"d290f1ee-6c54-4b01-90e6-d701748f0851","destination":"https://example.com","fallbackDestination":"https://example.com/fallback","leadGoalDefinition":"Increase newsletter signups","leadTargetDefinition":"Marketing qualified leads with budget > $10k","metadata":{},"name":"My Link","qrcodeDesignId":"a8c5e111-8894-4f8a-b5db-9efe0d12a210","qrcodeTemplateId":"0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d","shortlink":"my-link","tags":["string"],"waitForQrcode":true}'

Sample payload (application/json)

{
  "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "destination": "https://example.com",
  "fallbackDestination": "https://example.com/fallback",
  "leadGoalDefinition": "Increase newsletter signups",
  "leadTargetDefinition": "Marketing qualified leads with budget > $10k",
  "metadata": {},
  "name": "My Link",
  "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
  "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
  "shortlink": "my-link",
  "tags": [
    "string"
  ],
  "waitForQrcode": true
}

Typical response

{
  "link": {
    "createdAt": "2026-01-19T17:28:41.454Z",
    "customDomain": {
      "activatedAt": "2026-01-19T17:28:41.454Z",
      "createdAt": "2026-01-19T17:28:41.454Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "lastCheckedAt": "2026-01-19T17:28:41.454Z",
      "name": "example.com",
      "status": "STATUS_ACTIVE",
      "updatedAt": "2026-01-19T17:28:41.454Z",
      "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    },
    "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entrypoint": "https://linkbreak.ing/4BnH-R19p",
    "eventCount": 128,
    "fallbackDestination": "https://brand.example.com/fallback",
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "leadGoalDefinition": "string",
    "leadTargetDefinition": "string",
    "metadata": {},
    "name": "string",
    "pageTheme": {
      "backgroundColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "buttonColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.454Z",
      "id": "string",
      "updatedAt": "2026-01-19T17:28:41.454Z",
      "workspaceId": "string"
    },
    "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {}
      },
      "centralImageMargin": 0,
      "centralImageSignedUrl": "https://example.com",
      "centralImageSize": 0,
      "cornersDotOptions": {
        "themeColor": {},
        "type": "string"
      },
      "cornersSquareOptions": {
        "themeColor": {},
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.454Z",
      "dotsOptions": {
        "themeColor": {},
        "type": "string"
      },
      "errorCorrectionLevel": "string",
      "height": 0,
      "hideBackgroundDots": false,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-01-19T17:28:41.454Z",
      "width": 0
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "qrcodePendingUpdateSince": "2026-01-19T17:28:41.454Z",
    "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
    "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "shortlink": "4BnH-R19p",
    "tags": [
      {
        "createdAt": "2026-01-19T17:28:41.454Z",
        "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
        "name": "string",
        "updatedAt": "2026-01-19T17:28:41.454Z"
      }
    ],
    "updatedAt": "2026-01-19T17:28:41.454Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

POST/v1/links/contactRequires auth

#Create a new contact card link

This endpoint allows users to create a new vCard contact link in their Linkbreakers workspace. The link will generate a vCard file for contact information sharing.

#Parameters

This endpoint does not accept any parameters.

#Request body

customDomainId

string

The ID of the custom domain (UUID)

fallbackDestination

string

Optional fallback URL if vCard download fails or is not supported.

leadGoalDefinition

string

The lead goal definition for the link. This is a text field that can be used to describe the lead goal or purpose of the link.

leadTargetDefinition

string

The lead target definition for the link. This is a text field that can be used to describe the target lead criteria for the link.

metadata

object

A map of string key-value pairs. All values must be strings. Nested objects or arrays are not supported. Maximum of 50 keys.

name

string

The name of the link

qrcodeDesignId

string

qrcodeTemplateId

string

The ID of the QR Code template (UUID) If not given, the default QR Code template will be used to generate the QR Code design.

shortlink

string

The shortlink for the link If not given, the shortlink will be generated by the system.

tags

array<string>

List of tags to associate with the link. If a tag doesn't exist, it will be created.

vcardData

objectRequired

VCardData contains the contact information for vCard links

waitForQrcode

boolean

Wait for QR code generation to complete. Note: This makes the request slower compared to asynchronous generation.

#Response

200

Everything worked as expected.

link

object

Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata, letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X POST "https://api.linkbreakers.com/v1/links/contact" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"customDomainId":"d290f1ee-6c54-4b01-90e6-d701748f0851","fallbackDestination":"https://company.com/contact","leadGoalDefinition":"Capture contact information for sales outreach","leadTargetDefinition":"Business contacts interested in our services","metadata":{},"name":"Jane Doe Contact Card","qrcodeDesignId":"a8c5e111-8894-4f8a-b5db-9efe0d12a210","qrcodeTemplateId":"0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d","shortlink":"jane-contact","tags":["string"],"vcardData":{"buttonLabel":"Add to contacts","city":"San Francisco","country":"United States","email":"hello@acme.com","firstName":"Jane","lastName":"Doe","organization":"Acme Corporation","phone":"+33123456789","postalCode":"94102","state":"CA","streetAddress":"123 Main Street","title":"Software Engineer","website":"https://acme.com"},"waitForQrcode":true}'

Sample payload (application/json)

{
  "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "fallbackDestination": "https://company.com/contact",
  "leadGoalDefinition": "Capture contact information for sales outreach",
  "leadTargetDefinition": "Business contacts interested in our services",
  "metadata": {},
  "name": "Jane Doe Contact Card",
  "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
  "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
  "shortlink": "jane-contact",
  "tags": [
    "string"
  ],
  "vcardData": {
    "buttonLabel": "Add to contacts",
    "city": "San Francisco",
    "country": "United States",
    "email": "hello@acme.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "organization": "Acme Corporation",
    "phone": "+33123456789",
    "postalCode": "94102",
    "state": "CA",
    "streetAddress": "123 Main Street",
    "title": "Software Engineer",
    "website": "https://acme.com"
  },
  "waitForQrcode": true
}

Typical response

{
  "link": {
    "createdAt": "2026-01-19T17:28:41.455Z",
    "customDomain": {
      "activatedAt": "2026-01-19T17:28:41.455Z",
      "createdAt": "2026-01-19T17:28:41.455Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "lastCheckedAt": "2026-01-19T17:28:41.455Z",
      "name": "example.com",
      "status": "STATUS_ACTIVE",
      "updatedAt": "2026-01-19T17:28:41.455Z",
      "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    },
    "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entrypoint": "https://linkbreak.ing/4BnH-R19p",
    "eventCount": 128,
    "fallbackDestination": "https://brand.example.com/fallback",
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "leadGoalDefinition": "string",
    "leadTargetDefinition": "string",
    "metadata": {},
    "name": "string",
    "pageTheme": {
      "backgroundColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "buttonColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.455Z",
      "id": "string",
      "updatedAt": "2026-01-19T17:28:41.455Z",
      "workspaceId": "string"
    },
    "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {}
      },
      "centralImageMargin": 0,
      "centralImageSignedUrl": "https://example.com",
      "centralImageSize": 0,
      "cornersDotOptions": {
        "themeColor": {},
        "type": "string"
      },
      "cornersSquareOptions": {
        "themeColor": {},
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.455Z",
      "dotsOptions": {
        "themeColor": {},
        "type": "string"
      },
      "errorCorrectionLevel": "string",
      "height": 0,
      "hideBackgroundDots": false,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-01-19T17:28:41.455Z",
      "width": 0
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "qrcodePendingUpdateSince": "2026-01-19T17:28:41.455Z",
    "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
    "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "shortlink": "4BnH-R19p",
    "tags": [
      {
        "createdAt": "2026-01-19T17:28:41.455Z",
        "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
        "name": "string",
        "updatedAt": "2026-01-19T17:28:41.455Z"
      }
    ],
    "updatedAt": "2026-01-19T17:28:41.455Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

PATCH/v1/links/{id}Requires auth

#Update a link

Updates an existing shortened link in your Linkbreakers workspace.

#Parameters

path parameters

stringRequiredpath

The ID of the link to update (UUID)

#Request body

fallbackDestination

string

The fallback destination URL to use when workflow steps are broken

leadGoalDefinition

string

The lead goal definition for the link. This is a text field that can be used to describe the lead goal or purpose of the link.

leadTargetDefinition

string

The lead target definition for the link. This is a text field that can be used to describe the target lead criteria for the link.

name

string

The new name of the link

pageThemeId

string

Page theme ID to assign to this link

qrcodeTemplateId

string

QR code template ID to assign to this link

qrcodeTemplateIdDelete

boolean

Delete the QR code template ID from this link If true, the qrcode_template_id will be set to null

tags

array<string>

Set the tags to associate with the link. If a tag with the given name doesn't exist, it will be created.

tagsDelete

boolean

Delete all tags from the link If true, all tags will be removed from the link.

#Response

200

Everything worked as expected.

link

object

Core resource that ties a shortlink or QR entrypoint to its workflow, destination, and analytics metadata, letting Linkbreakers serve dynamic experiences while tracking scans for a workspace.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Example request (cURL)

curl -X PATCH "https://api.linkbreakers.com/v1/links/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{"fallbackDestination":"https://example.com/fallback","leadGoalDefinition":"Increase newsletter signups","leadTargetDefinition":"Marketing qualified leads with budget > $10k","name":"My Updated Link","pageThemeId":"f47ac10b-58cc-4372-a567-0e02b2c3d479","qrcodeTemplateId":"0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d","qrcodeTemplateIdDelete":false,"tags":["string"],"tagsDelete":false}'

Sample payload (application/json)

{
  "fallbackDestination": "https://example.com/fallback",
  "leadGoalDefinition": "Increase newsletter signups",
  "leadTargetDefinition": "Marketing qualified leads with budget > $10k",
  "name": "My Updated Link",
  "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
  "qrcodeTemplateIdDelete": false,
  "tags": [
    "string"
  ],
  "tagsDelete": false
}

Typical response

{
  "link": {
    "createdAt": "2026-01-19T17:28:41.457Z",
    "customDomain": {
      "activatedAt": "2026-01-19T17:28:41.457Z",
      "createdAt": "2026-01-19T17:28:41.457Z",
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "lastCheckedAt": "2026-01-19T17:28:41.457Z",
      "name": "example.com",
      "status": "STATUS_ACTIVE",
      "updatedAt": "2026-01-19T17:28:41.457Z",
      "workspaceId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    },
    "customDomainId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "entrypoint": "https://linkbreak.ing/4BnH-R19p",
    "eventCount": 128,
    "fallbackDestination": "https://brand.example.com/fallback",
    "id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "leadGoalDefinition": "string",
    "leadTargetDefinition": "string",
    "metadata": {},
    "name": "string",
    "pageTheme": {
      "backgroundColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "buttonColor": {
        "colors": [],
        "direction": "string",
        "stops": [],
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.457Z",
      "id": "string",
      "updatedAt": "2026-01-19T17:28:41.457Z",
      "workspaceId": "string"
    },
    "pageThemeId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "qrcodeDesign": {
      "backgroundOptions": {
        "themeColor": {}
      },
      "centralImageMargin": 0,
      "centralImageSignedUrl": "https://example.com",
      "centralImageSize": 0,
      "cornersDotOptions": {
        "themeColor": {},
        "type": "string"
      },
      "cornersSquareOptions": {
        "themeColor": {},
        "type": "string"
      },
      "createdAt": "2026-01-19T17:28:41.457Z",
      "dotsOptions": {
        "themeColor": {},
        "type": "string"
      },
      "errorCorrectionLevel": "string",
      "height": 0,
      "hideBackgroundDots": false,
      "id": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
      "outputFileFormat": "OUTPUT_FILE_FORMAT_PNG",
      "shape": "SHAPE_SQUARE",
      "updatedAt": "2026-01-19T17:28:41.457Z",
      "width": 0
    },
    "qrcodeDesignId": "a8c5e111-8894-4f8a-b5db-9efe0d12a210",
    "qrcodePendingUpdateSince": "2026-01-19T17:28:41.457Z",
    "qrcodeSignedUrl": "https://cdn.linkbreakers.com/qrcodes/1b9d6bcd.png?signature=abc123",
    "qrcodeTemplateId": "0d7f4d9c-1aef-4ed4-821b-321a3f9cba1d",
    "shortlink": "4BnH-R19p",
    "tags": [
      {
        "createdAt": "2026-01-19T17:28:41.457Z",
        "id": "d87a9b30-5c8b-4d4e-9fd3-5f5f5f5f5f5f",
        "name": "string",
        "updatedAt": "2026-01-19T17:28:41.457Z"
      }
    ],
    "updatedAt": "2026-01-19T17:28:41.457Z",
    "workspaceId": "c0d3cafe-5b1e-4d42-a6fd-0c5f5c3962d0"
  }
}

Base URL: https://api.linkbreakers.com

DELETE/v1/links/{id}Requires auth

#Delete a link

Removes a shortened link from the workspace. This operation cannot be undone.

#Parameters

path parameters

stringRequiredpath

The ID of the link to delete (UUID)

#Response

200

Everything worked as expected.

No structured schema available for this section.

#Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

objectRequired

Wrapped error response.

Links

#The Link object

#List links

#Parameters

query parameters

#Response

#Error response

#Get link details

#Parameters

path parameters

query parameters

#Response

#Error response

#Get lead score explanation

#Parameters

path parameters

#Response

#Error response

#Check shortlink availability

#Parameters

query parameters

#Response

#Error response

#Get a random shortlink

#Parameters

#Response

#Error response

#Create a new link

#Parameters

#Request body

#Response

#Error response

#Create a new contact card link

#Parameters

#Request body

#Response

#Error response

#Update a link

#Parameters

path parameters

#Request body

#Response

#Error response

#Delete a link

#Parameters

path parameters

#Response

#Error response