Links
create_link — Create Short Link
create_link — Create Short Link
Creates. Create a trackable short link. The link is a live endpoint: it keeps resolving after the conversation ends, and its destination can be changed later with
update_link.string
required
The destination URL to shorten.
string
Custom domain.
string
Custom slug. Auto-generated if omitted.
string
Your own reference ID for the link.
string[]
Tag IDs to associate.
string
Internal notes.
string
Expiration date, ISO 8601.
string
Password-protect the link.
list_links — List Short Links
list_links — List Short Links
get_link_info — Get Link Details
get_link_info — Get Link Details
Read. Details for one short link. Identify it by
linkId, by externalId, or by domain and key together — for codeqr.link/github, that is domain codeqr.link and key github. At least one is required.string
The link ID, as returned by
list_links.string
Your own ID for the link, if you set one.
string
The link domain. Use with
key.string
The link slug. Use with
domain.update_link — Update Short Link
update_link — Update Short Link
Overwrites. Change where an existing short link points. Anything already shared keeps working and now leads to the new destination — unless you also change
key, which rewrites the link itself and breaks every copy already in circulation.string
required
The link ID to update.
string
New destination URL.
string
New slug. Breaks existing copies.
boolean
Archive status.
string
New expiration date.
string
Updated comments.
delete_link — Delete Short Link
delete_link — Delete Short Link
Overwrites. Delete a short link. Anything already shared stops resolving.
string
required
The link ID to delete.
QR codes
create_qrcode — Create QR Code
create_qrcode — Create QR Code
Creates. Create a dynamic QR code. The printed pattern encodes a short link rather than the content itself, so what it leads to can be changed later without reprinting, and every scan is recorded.Pass the payload field matching the
type you choose.string
url · text · email · phone · sms · wifi · vcard · crypto · whatsapp. Defaults to url.string
For type
url: the destination the code should lead to.string
For type
text: the plain text to encode.string
For type
phone: the number to call, e.g. +5511999999999.object
For type
email: the message a scan should open.object
For type
sms: the message a scan should compose.object
For type
wifi: the network a scan should join.object
For type
vcard: the contact card a scan should offer to save. City, state, zipcode and country are only encoded when address is also given.object
For type
crypto: the payment request a scan should open.object
For type
whatsapp: the conversation a scan should open.Three sub-fields are named in a way nobody guesses, and a wrong key saves without error and encodes nothing: the recipient in
crypto is address, the blind-copy field in email is cco, and sms carries a subject.string
Domain for the underlying short link.
string
Custom slug for the underlying short link.
number
Size in pixels.
string
Error correction level:
L · M · Q · H.string
Foreground color, hex.
string
Background color, hex.
list_qrcodes — List QR Codes
list_qrcodes — List QR Codes
Read. List all QR codes in the workspace.
number
Page number.
update_qrcode — Update QR Code
update_qrcode — Update QR Code
Overwrites. Change what a dynamic QR code leads to without reprinting it: copies already distributed now resolve to the new content.Pass the payload field matching the type the code already has —
url for a link code, wifi for a Wi-Fi code. A code cannot be converted from one type to another here: sending a wifi payload to a url code is accepted and silently changes nothing, so check the type with list_qrcodes first if you are unsure.string
required
The QR code ID to update.
string
For a
url code: the new destination.string
For a
text code: the new plain text.string
For a
phone code: the new number.object
For an
email code: the new message.object
For an
sms code: the new message.object
For a
wifi code: the new network.object
For a
vcard code: the new contact card.object
For a
crypto code: the new payment request.object
For a
whatsapp code: the new conversation.string
New foreground color, hex.
string
New background color, hex.
boolean
Archive status.
delete_qrcode — Delete QR Code
delete_qrcode — Delete QR Code
Overwrites. Delete a QR code. Any printed copy stops resolving and cannot be recovered by reprinting.
string
required
The QR code ID to delete.
Analytics
get_analytics — Get Analytics
get_analytics — Get Analytics
Read. Scan and click analytics — workspace-wide, or for one link or QR code.
string
required
clicks · scans · leads · sales · composite. Use scans for QR codes and clicks for short links.string
required
count · timeseries · countries · cities · devices · browsers · os · referers · top_links · top_qrcodes · top_urls.string
Filter by link ID.
string
Filter by QR code ID.
string
Filter by domain.
string
Filter by slug. Use with
domain.string
1h · 24h · 7d · 30d · 90d · ytd · 1y · all. Defaults to 24h.How far back you can look depends on your plan, and a longer window returns
403 rather than a truncated result: Free stops at 30 days, Starter at 90 days, Pro at 1 year, Business has no limit.Workspace
list_domains — List Custom Domains
list_domains — List Custom Domains
create_tag — Create Tag
create_tag — Create Tag
get_workspace — Get Workspace
get_workspace — Get Workspace
Read. The workspace this connection is authorized for, including its name, slug and plan. Useful before creating in bulk, or before using a feature the plan may not include.Takes no arguments.
Not available here
Conversion tracking.track_lead and track_sale are not exposed. They need the conversions.write scope, which cannot be requested without locking non-owners out of the connection entirely. Use the API for conversions.