API & Webhooks

Build on MASK with a powerful API.

Manage your short links via our REST API. Scoped API keys, rate limiting, and real-time webhooks for seamless integration.

Get started free Talk to sales

Create a short link

curl -X POST https://api.mask.pk/v1/links \
  -H "Authorization: Bearer mk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/long-page",
    "slug": "launch",
    "domain": "go.yourbrand.com"
  }'

API Features

Everything you need to integrate.

Scoped API Keys

Create multiple API keys with different scopes. Rotate keys without downtime. Revoke instantly.

Rate Limiting

Generous rate limits that scale with your plan. Clear headers tell you exactly where you stand.

Webhook Events

Real-time notifications for link.created, link.clicked, page.published, and more. HMAC-signed payloads.

RESTful Design

Predictable resource-oriented URLs, standard HTTP methods, and consistent JSON responses.

Error Handling

Structured error responses with codes, messages, and suggestions. Never guess what went wrong.

Webhook events

link.createdA new short link was created

link.clickedA short link was clicked

link.updatedA link was modified

link.deletedA link was deleted

qr.createdA QR code was created

page.publishedA bio page was published

domain.verifiedA custom domain was verified

Start building today.

Free to start, ready to scale. Get your API keys and make your first request in minutes.