Skip to main content
GET
Retrieve a personal link

Authorizations

Authorization
string
header
required

A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.

Path Parameters

id
string
required

Response

OK

id
string
required
Pattern: ^lk_
Example:

"lk_q4x7mz"

object
string
required
Allowed value: "personal_link"
name
string
required
page
string
required

The page it opens: a path on the workspace's website, or a full address.

greeting
string | null
required

The greeting it shows (gr_…); null for a draft.

status
enum<string>
required

draft: no greeting yet, so it greets no one.

Available options:
active,
draft
url
string | null
required

The page with the link's id. Add a person's details as dw_email, dw_first, dw_last, dw_company and dw_title, or ask POST /personal_links/{id}/urls to do it. Null for a draft.

Example:

"https://www.acme.example/pricing?dw=lk_q4x7mz"

fields
string[]
required

The details its greeting uses: first_name, last_name, company, title.

templates
object | null
required

The address with each email tool's merge fields (hubspot, instantly, apollo, outreach, salesloft, lemlist, other), ready to paste into a sequence. Null for a draft.

results
object
required

The last 30 days: people who opened it, how many of them chatted, and how many booked. Your team's and test visits are left out.