#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
objectCaptures 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
stringThe 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
stringThe 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
stringThe fallback destination URL to use when workflow steps are broken
id
stringThe unique identifier of the link (UUID)
leadGoalDefinition
stringThe 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
stringThe 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
objectA map of string key-value pairs. All values must be strings. Nested objects or arrays are not supported. Maximum of 50 keys.
name
stringThe name of the link
qrcodeDesign
objectCaptures 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
stringThe 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
stringThe signed URL for the QR Code image. This URL eventually expires.
qrcodeTemplateId
stringThe 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
stringThe 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
stringThe workspace ID the link belongs to (UUID)