API

wedlink API

Create and manage wedding links from your own product.

A small, predictable REST API. Every response is JSON, every error carries a machine-readable code, and the whole surface is nine endpoints.

Authentication

Send your key as a bearer token. Keys are issued per environment and can be rotated at any time.

Authorization: Bearer wl_live_...

Agent Skill file

Building with a coding agent? Drop our Skill file into your project and your agent can integrate wedlink without reading these docs.

Download the Skill

Endpoints

MethodPathDescription
GET/api/availabilityCheck whether a slug is free
GET/api/qrRender a QR code (SVG or PNG)
GET/api/v1/linksList your links
POST/api/v1/linksCreate a link
GET/api/v1/links/{slug}Fetch one link
PATCH/api/v1/links/{slug}Change the destination
DELETE/api/v1/links/{slug}Delete a link

Rate limits

Requests are limited per key. Current usage is returned in the response headers.

OpenAPI specification

Need API access?

Tell us what you're building and we'll set you up with a key.

Get in touch