Skip to main content
GET
Retrieve a Custom Link
Requires custom_links:read or custom_links:write. Use the returned url for the published experience. A 404 means the link does not exist in the API key’s organization. The engagement.stage value advances monotonically from not_opened to opened, started, and engaged. Lead and meeting fields are conversion flags; they are not additional engagement stages. Lower-funnel conversion evidence can advance the lifecycle when an earlier browser event was missed.

Authorizations

Authorization
string
header
required

Hobbes API key with the hb_live_ prefix.

Path Parameters

Custom Link UUID.

Response

Successful Response

id
string<uuid>
required
displayName
string
required
active
boolean
required
url
string
required
thumbnailStatus
enum<string>
required
Available options:
not_requested,
provided,
queued,
processing,
generated,
fallback,
failed,
cancelled
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
engagement
CustomLinkEngagement · object
required
externalId
string | null
firstName
string | null
lastName
string | null
email
string | null
phone
string | null
role
string | null
company
string | null
context
string | null
shareTitle
string | null
shareDescription
string | null
shareThumbnailUrl
string | null
prospectLogoUrl
string | null
prospectDomain
string | null
campaignId
string<uuid> | null
jobId
string<uuid> | null
thumbnailAttempts
integer
default:0
thumbnailError
CustomLinkError · object | null