List Custom Links
Custom Links
List Custom Links
Return a filterable, paginated list of Custom Links.
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
Hobbes API key with the hb_live_ prefix.
Query Parameters
Custom Link campaign UUID.
Maximum string length:
255Exact prospect email address. URL-encode reserved characters.
Maximum string length:
255Maximum string length:
255Maximum string length:
255Filter Custom Links by their monotonic not_opened, opened, started, or engaged stage.
Available options:
not_opened, opened, started, engaged Sort by created_at or last_activity_at.
Available options:
created_at, last_activity_at Sort direction: asc or desc.
Available options:
asc, desc Number of records to return. Defaults to 50 and cannot exceed 200.
Required range:
1 <= x <= 200Zero-based number of records to skip. Use with pagination.total to request the next page.
Required range:
0 <= x <= 1000000