Skip to main content
GET
List Custom Links
Requires custom_links:read or custom_links:write. Filter by campaign, active status, engagement stage, external id, email, company, creation date, or search text. Sort by creation time or latest activity. Results include the published URL, thumbnail state, and engagement rollup. loadCount counts accepted non-bot load events; pageViewCount deduplicates them by page-view id. uniqueVisitorCount uses persistent anonymous browser continuity where storage is available and includes ephemeral page views as an estimate where it is not. Check visitorCountMode before interpreting the total. When it is estimated, loadsPerUniqueVisitor is approximate. persistentUniqueVisitorCount and ephemeralPageViewCount expose the exact coverage inputs. loadsPerUniqueVisitor is null until at least one visitor is observed.

Authorizations

Authorization
string
header
required

Hobbes API key with the hb_live_ prefix.

Query Parameters

campaign_id
string<uuid> | null

Custom Link campaign UUID.

active
boolean | null
external_id
string | null
Maximum string length: 255
email
string | null

Exact prospect email address. URL-encode reserved characters.

Maximum string length: 255
company
string | null
Maximum string length: 255
search
string | null
Maximum string length: 255
date_from
string<date-time> | null
date_to
string<date-time> | null
engagement_stage
enum<string> | null

Filter Custom Links by their monotonic not_opened, opened, started, or engaged stage.

Available options:
not_opened,
opened,
started,
engaged
sort
enum<string>
default:created_at

Sort by created_at or last_activity_at.

Available options:
created_at,
last_activity_at
order
enum<string>
default:desc

Sort direction: asc or desc.

Available options:
asc,
desc
limit
integer
default:50

Number of records to return. Defaults to 50 and cannot exceed 200.

Required range: 1 <= x <= 200
offset
integer
default:0

Zero-based number of records to skip. Use with pagination.total to request the next page.

Required range: 0 <= x <= 1000000

Response

Successful Response

total
integer
required
limit
integer
required
offset
integer
required