Workspace documentation

Lynko Workspace Docs

Learn how Lynko workspace options, developer API access, webhooks and analytics fit together so you can build links, QR codes and campaign flows with confidence.

Open Developer workspace Download OpenAPI spec

Workspace overview

One workspace for every public touchpoint

A Lynko workspace keeps your public links, QR codes, pages, campaigns and reporting in one place. Each tool can work on its own, but the strongest workflows combine them.

Short links

Create clean shareable links with optional tracking, expiry rules, passwords, Smart Redirects and public stats.

Dynamic QR codes

Create QR codes that can keep the same printed code while the destination changes later.

Link pages

Publish link-in-bio pages for social profiles, campaigns, events and important destinations.

Campaign Kits

Bundle short links, QR codes, landing pages, polls, Reward Unlock blocks and reports around one promotion.

Smart Cards

Prepare printable or digital cards with QR destinations you can update from the workspace.

Polls and AMA pages

Collect votes or questions from your audience and review activity from the same account.

Support Hubs

Share donation, shop, contact and community links from a public support page.

Counters and Insight Pixels

Measure visits with lightweight counters and privacy-friendly workspace analytics.

Workspace options

What you can manage from the dashboard

Workspace options cover content creation, analytics, imports, exports, developer access and privacy-minded controls. Plan limits apply to active or tracked assets, while untracked short links remain unlimited.

Asset management

Create, edit, pause, restore and organize your public Lynko assets from the dashboard.

Analytics

Review clicks, scans, views, votes, referrers, devices, languages and campaign results where tracking is enabled.

Plan-sensitive limits

Tracked short links, published pages, active QR codes, Smart Cards, polls, counters, pixels, Support Hub buttons and Campaign Kits follow plan limits.

Imports and exports

Move workspace data in and out with supported CSV and export tools where your plan allows it.

Developer access

Create scoped API keys, connect webhooks and automate supported workspace actions.

Privacy controls

Use privacy-friendly analytics, root Lynko URLs, safe uploads and ownership checks across workspace tools.

Developer API

API quick start

The Lynko API is a full-platform JSON API for workspace automation. Create an API key in the Developer workspace, choose only the permissions your integration needs, then send requests to the API base URL.

Base URL /api/v1
Authentication X-API-Key or Authorization: Bearer API_KEY
Response format Raw JSON
OpenAPI /openapi.json

Authentication

Use X-API-Key for the most reliable API authentication. Authorization Bearer tokens are also supported when your hosting environment passes Authorization headers to PHP.

A 401 response means the key was not accepted. Check that the key is active, not revoked, copied without spaces, and belongs to the API host you are calling.

Plan-based API rate limits
Plan Requests per minute Requests per day
Free / Bronze 20 1000
Silver 60 5000
Gold 120 20000

Reads use normal limits. Writes and analytics summaries use stricter limits, while exports, webhook tests and small uploads use the strictest limits.

Usage examples

Use the API in different ways

These examples show the common patterns. Replace YOUR_API_KEY with a scoped key from the Developer workspace and keep that key private.

The JavaScript example must be run in a browser console or Node.js, not directly in Windows PowerShell. For PowerShell, use the Windows PowerShell example.

Check your API key

curl -H "X-API-Key: YOUR_API_KEY" https://lynko.tv/api/v1/me

Create a short link with cURL

curl -X POST https://lynko.tv/api/v1/shortlinks \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/landing","title":"Campaign launch"}'

Create a QR code with JavaScript

const response = await fetch('https://lynko.tv/api/v1/qr-codes', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    target_url: 'https://example.com/menu',
    title: 'Menu QR code'
  })
});

const qrCode = await response.json();

Create a QR code with Windows PowerShell

$headers = @{
  'X-API-Key' = 'YOUR_API_KEY'
}

$body = @{
  target_url = 'https://example.com/menu'
  title = 'Menu QR code'
} | ConvertTo-Json

$response = Invoke-RestMethod `
  -Uri 'https://lynko.tv/api/v1/qr-codes' `
  -Method Post `
  -Headers $headers `
  -ContentType 'application/json' `
  -Body $body

$response

Read analytics with PHP

<?php
$ch = curl_init('https://lynko.tv/api/v1/analytics/summary');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER => ['X-API-Key: YOUR_API_KEY'],
  CURLOPT_RETURNTRANSFER => true,
]);
$json = curl_exec($ch);
curl_close($ch);
$summary = json_decode((string)$json, true);

Automate campaign setup

Create a short link, create a QR code for the same destination, then review performance from analytics.

Sync public destinations

Update link pages, Smart Cards, Support Hubs or QR destinations from your own internal tools.

Build reporting dashboards

Pull workspace analytics summaries and combine them with your own campaign notes or client reports.

Receive events with webhooks

Use webhooks for link clicks, QR scans, capture submissions, campaign leads, poll votes and billing changes.

Permissions and endpoints

Choose the smallest useful permission set

API keys are scoped. Give each integration only the permissions it needs, then rotate or revoke keys from the Developer workspace when access is no longer needed.

Account

  • account:readRead account email and subscription details

Core assets

  • links:readRead short links
  • links:writeCreate and update short links
  • qr:readRead QR codes
  • qr:writeCreate and update QR codes
  • trees:readRead link pages
  • trees:writeCreate and update link pages

Engagement

  • polls:readRead polls
  • polls:writeCreate and update polls
  • ama:readRead AMA pages
  • ama:writeManage AMA pages
  • capture:readRead Reward Unlock data
  • capture:writeManage Reward Unlock blocks

Workspace tools

  • campaigns:readRead Campaign Kits
  • campaigns:writeCreate and update Campaign Kits
  • cards:readRead Smart Cards
  • cards:writeCreate and update Smart Cards
  • counters:readRead counters and Insight Pixels
  • counters:writeCreate and update counters and Insight Pixels
  • support:readRead Support Hub
  • support:writeManage Support Hub
  • drops:readRead Creator Drops
  • drops:writeCreate and update Creator Drops

Integrations

  • analytics:readRead analytics summaries
  • webhooks:writeManage webhooks
  • uploads:writeUpload small API media

Account

GET /api/v1/me Account and API key details account:read for email and subscription details
GET /api/v1/rate-limits Current plan limits and endpoint costs -

Core assets

GET /api/v1/shortlinks List short links links:read
POST /api/v1/shortlinks Create a short link links:write
GET /api/v1/qr-codes List QR codes qr:read
POST /api/v1/qr-codes Create a QR code qr:write
GET /api/v1/link-pages List link pages trees:read
POST /api/v1/link-pages Create a link page trees:write

Engagement

GET /api/v1/polls List polls polls:read
POST /api/v1/polls Create a poll polls:write
GET /api/v1/ama Read AMA settings ama:read
POST /api/v1/ama Create or update AMA settings ama:write
GET /api/v1/capture/blocks List Reward Unlock blocks capture:read
POST /api/v1/capture/blocks Create or update a Reward Unlock block capture:write
GET /api/v1/capture/submissions List Reward Unlock submissions capture:read

Workspace tools

GET /api/v1/campaign-kits List Campaign Kits campaigns:read
POST /api/v1/campaign-kits Create a Campaign Kit campaigns:write
GET /api/v1/smart-cards List Smart Cards cards:read
POST /api/v1/smart-cards Create a Smart Card cards:write
GET /api/v1/counters List counters and Insight Pixels counters:read
POST /api/v1/counters Create a counter or Insight Pixel counters:write
GET /api/v1/support-hub Read Support Hub settings support:read
PUT /api/v1/support-hub Update Support Hub settings support:write
GET /api/v1/creator-drops List Creator Drops drops:read
POST /api/v1/creator-drops Create a Creator Drop drops:write
POST /api/v1/creator-drops/{id}/images Upload one Creator Drop image drops:write + uploads:write

Integrations

GET /api/v1/analytics/summary Read workspace analytics summary analytics:read
GET /api/v1/webhooks List webhook endpoints webhooks:write
POST /api/v1/webhooks Create a webhook endpoint webhooks:write
PATCH /api/v1/webhooks/{id} Update a webhook endpoint webhooks:write
DELETE /api/v1/webhooks/{id} Delete a webhook endpoint webhooks:write
POST /api/v1/webhooks/{id}/test Queue a webhook test event webhooks:write

Next steps

Helpful workspace links

Use these pages when you are ready to create API keys, connect webhooks, export data or ask for integration help.

Open Developer workspace Create API keys, review limits and manage developer access. Download OpenAPI spec Use the machine-readable API description in developer tools. Manage webhooks Connect event delivery for supported workspace actions. Import and export data Move workspace data with supported dashboard tools. Contact support Ask for help with workspace setup, API access or integration questions.