Retrieve a Custom Link
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/custom-links/{link_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/custom-links/{link_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/custom-links/{link_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>",
"active": true,
"url": "<string>",
"thumbnailStatus": "not_requested",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"engagement": {
"stage": "not_opened",
"openObserved": true,
"botScannedOnly": true,
"pageViewCount": 123,
"uniqueVisitorCount": 123,
"persistentUniqueVisitorCount": 123,
"ephemeralPageViewCount": 123,
"loadsPerUniqueVisitor": 123,
"firstOpenedAt": "2023-11-07T05:31:56Z",
"lastOpenedAt": "2023-11-07T05:31:56Z",
"sessionCount": 123,
"startedSessionCount": 123,
"engagedSessionCount": 123,
"leadSubmitted": true,
"meetingClicked": true,
"meetingBooked": true,
"lastActivityAt": "2023-11-07T05:31:56Z",
"lastActivityType": "<string>",
"firstStartedAt": "2023-11-07T05:31:56Z",
"firstEngagedAt": "2023-11-07T05:31:56Z",
"firstLeadSubmittedAt": "2023-11-07T05:31:56Z",
"firstMeetingClickedAt": "2023-11-07T05:31:56Z",
"firstMeetingBookedAt": "2023-11-07T05:31:56Z",
"loadCount": 123,
"visitorCountMode": "identified"
},
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"company": "<string>",
"context": "<string>",
"shareTitle": "<string>",
"shareDescription": "<string>",
"shareThumbnailUrl": "<string>",
"prospectLogoUrl": "<string>",
"prospectDomain": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thumbnailAttempts": 0,
"thumbnailError": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "Custom Link not found in the key's organization."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Custom Links
Retrieve a Custom Link
Return one Custom Link with its thumbnail and engagement state.
GET
/
api
/
v1
/
custom-links
/
{link_id}
Retrieve a Custom Link
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/custom-links/{link_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/custom-links/{link_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/custom-links/{link_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayName": "<string>",
"active": true,
"url": "<string>",
"thumbnailStatus": "not_requested",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"engagement": {
"stage": "not_opened",
"openObserved": true,
"botScannedOnly": true,
"pageViewCount": 123,
"uniqueVisitorCount": 123,
"persistentUniqueVisitorCount": 123,
"ephemeralPageViewCount": 123,
"loadsPerUniqueVisitor": 123,
"firstOpenedAt": "2023-11-07T05:31:56Z",
"lastOpenedAt": "2023-11-07T05:31:56Z",
"sessionCount": 123,
"startedSessionCount": 123,
"engagedSessionCount": 123,
"leadSubmitted": true,
"meetingClicked": true,
"meetingBooked": true,
"lastActivityAt": "2023-11-07T05:31:56Z",
"lastActivityType": "<string>",
"firstStartedAt": "2023-11-07T05:31:56Z",
"firstEngagedAt": "2023-11-07T05:31:56Z",
"firstLeadSubmittedAt": "2023-11-07T05:31:56Z",
"firstMeetingClickedAt": "2023-11-07T05:31:56Z",
"firstMeetingBookedAt": "2023-11-07T05:31:56Z",
"loadCount": 123,
"visitorCountMode": "identified"
},
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"phone": "<string>",
"role": "<string>",
"company": "<string>",
"context": "<string>",
"shareTitle": "<string>",
"shareDescription": "<string>",
"shareThumbnailUrl": "<string>",
"prospectLogoUrl": "<string>",
"prospectDomain": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thumbnailAttempts": 0,
"thumbnailError": {
"code": "<string>",
"message": "<string>"
}
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "Custom Link not found in the key's organization."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}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
bearerapiKeyHeader
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 Show child attributes
Show child attributes
Show child attributes
Show child attributes