Zingalinks API v1

The Zingalinks endpoints — mint short links, render QR codes, read click/scan analytics and register branded hosts. Authenticate with a zk_ key carrying data:read / data:write:*. Needs an active Zingalinks plan (its own, or a paid ZingaConnect plan, which bundles it); custom domains need Starter or above.

Short links

Mint and manage short links. The slug is immutable; the destination is not.

GET/linksList links

source defaults to app (your own links); pass crm for links ZingaConnect minted for campaigns, or all.

Name	In	Type	Description
`source`	query	string	app\|crm\|all
`status`	query	string	active\|archived\|disabled
`q`	query	string	Slug or title substring
`limit`	query	integer	Page size (1-200, default 50)
`offset`	query	integer	Rows to skip

TrialServerAuth token → Authorizationsource (query)status (query)q (query)limit (query)offset (query)

POST/linksCreate a link

Omit slug for a short unguessable one. domainId publishes on one of your verified hosts (Starter+).

TrialServerAuth token → AuthorizationRequest body (JSON)

GET/links/{link_id}Get a link

Name	In	Type	Req	Description
`link_id`	path	string	yes	Link id

TrialServerAuth token → Authorizationlink_id (path, required)

PATCH/links/{link_id}Update a link

Re-point (targetUrl), retitle, retag, set expiresAt, or set status to active|archived|disabled. The edge is updated in the same call. The slug is immutable by design.

Name	In	Type	Req	Description
`link_id`	path	string	yes	Link id

TrialServerAuth token → Authorizationlink_id (path, required)Request body (JSON)

DELETE/links/{link_id}Delete a link

Soft-deletes and drops the edge mirror — the short URL stops resolving. Use status: disabled to pause instead.

Name	In	Type	Req	Description
`link_id`	path	string	yes	Link id

TrialServerAuth token → Authorizationlink_id (path, required)

Analytics & QR

Clicks, scans and the 'who clicked' roster; plus a QR of the link's short URL.

GET/links/{link_id}/statsClick & scan statistics

Bot hits are excluded. identity counts are returned on every plan; the named roster needs a paid ZingaConnect plan.

Name	In	Type	Req	Description
`link_id`	path	string	yes	Link id
`days`	query	integer		Window in days (1-365)

TrialServerAuth token → Authorizationlink_id (path, required)days (query)

GET/links/{link_id}/qrRender a QR code

Returns image bytes (not JSON) for the link's short URL. fmt=svg for print. URL-encode a colour's # as %23.

Name	In	Type	Req	Description
`link_id`	path	string	yes	Link id
`fmt`	query	string		png\|svg
`size`	query	integer		PNG pixel size (64-2000)
`dark`	query	string		Foreground colour
`light`	query	string		Background colour

TrialServerAuth token → Authorizationlink_id (path, required)fmt (query)size (query)dark (query)light (query)

Custom domains

Branded short-link hosts (Starter+). DNS verification is completed in the console.

GET/links/domainsList custom domains

TrialServerAuth token → Authorization

POST/links/domainsRegister a custom domain

Starts pending; point its DNS at the edge and verify in the console.

TrialServerAuth token → AuthorizationRequest body (JSON)

DELETE/links/domains/{domain_id}Remove a custom domain

Links on it stop resolving — keep it while printed material is in circulation.

Name	In	Type	Req	Description
`domain_id`	path	string	yes	Domain id

TrialServerAuth token → Authorizationdomain_id (path, required)

← All APIs