Retrieve a Custom Link
Custom Links
Retrieve a Custom Link
Return one Custom Link with its thumbnail and engagement state.
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
Hobbes API key with the hb_live_ prefix.
Path Parameters
Custom Link UUID.
Response
Successful Response
Available options:
not_requested, provided, queued, processing, generated, fallback, failed, cancelled