Developer API

Returns a paginated list of all short links belonging to the authenticated user.

curl https://tinyzy.com/api/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY"

const res = await fetch('https://tinyzy.com/api/v1/links', {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
const data = await res.json();

{
  "status": "success",
  "data": [
    {
      "id": 42,
      "slug": "abc123",
      "destination": "https://example.com/page",
      "short_url": "https://tnyzy.com/abc123",
      "clicks": 187,
      "status": "active",
      "created_at": "2025-03-01T10:00:00Z"
    }
  ],
  "meta": { "total": 84, "page": 1, "limit": 20 }
}

Creates a new short link for the authenticated user. Returns the full link object including the generated short URL.

curl -X POST https://tinyzy.com/api/v1/links/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com","title":"My Link"}'

const res = await fetch('https://tinyzy.com/api/v1/links/create', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ destination: 'https://example.com' })
});

{
  "status": "success",
  "data": {
    "id": 43,
    "slug": "xyz789",
    "short_url": "https://tnyzy.com/xyz789",
    "destination": "https://example.com",
    "clicks": 0,
    "status": "active"
  }
}

Retrieve full details of a single short link by its slug.

curl https://tinyzy.com/api/v1/links/abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Update the destination URL, title, or slug of an existing short link.

Permanently deletes a short link. This action cannot be undone. The slug becomes available for reuse.

Pauses a short link. Visitors will receive a 404 response instead of being redirected. The link and its data are preserved.

curl -X PATCH https://tinyzy.com/api/v1/links/abc123/pause \
  -H "Authorization: Bearer YOUR_API_KEY"

Re-activates a paused short link. Visitors will be redirected normally again.

Returns click totals, referrers, countries, browsers, and devices for the specified link.

{
  "status": "success",
  "data": {
    "total_clicks": 1240,
    "unique_clicks": 890,
    "top_countries": [{"country":"US","clicks":540}],
    "top_referrers": [{"referrer":"google.com","clicks":320}]
  }
}

Builds a UTM-tagged URL from the provided parameters. Optionally shortens the generated URL and returns the short link.

curl -X POST https://tinyzy.com/api/v1/utm/build \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/sale",
    "source": "newsletter",
    "medium": "email",
    "campaign": "spring-2025",
    "shorten": true
  }'

const res = await fetch('https://tinyzy.com/api/v1/utm/build', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://example.com/sale',
    source: 'newsletter', medium: 'email',
    campaign: 'spring-2025', shorten: true
  })
});

{
  "status": "success",
  "data": {
    "utm_url": "https://example.com/sale?utm_source=newsletter&utm_medium=email&utm_campaign=spring-2025",
    "parameters": { "utm_source":"newsletter", "utm_medium":"email", "utm_campaign":"spring-2025" },
    "short_url": "https://tnyzy.com/utm45",
    "slug": "utm45"
  }
}

Returns all custom domains registered by the authenticated user, including their verification and primary status.

{
  "status": "success",
  "data": [
    {
      "id": 3,
      "domain": "links.mybrand.com",
      "verified": true,
      "is_primary": true,
      "status": "active"
    }
  ]
}

Registers a new custom domain. After adding, configure a CNAME record pointing to TinyZy, then call the verify endpoint.

Removes a custom domain. Links using this domain will stop redirecting. Use the raw numeric ID returned from the list endpoint.

curl -X DELETE https://tinyzy.com/api/v1/domains/3 \
  -H "Authorization: Bearer YOUR_API_KEY"

Triggers a DNS CNAME check. If the CNAME record is live and pointing correctly, the domain is marked as verified and activated.

{
  "status": "success",
  "verified": true,
  "message": "Domain verified and activated"
}

Generates a new API key for your account. The full key is only shown once — store it securely.

Returns all API keys for your account. Only the masked version of each key is returned — the full key is only shown at creation time.

Permanently revokes an API key. Any application using this key will immediately lose API access.