Documentation

Developer docs and integration guides

Everything you need to integrate Valqor into your stack.

Getting Started

Create your first branded link, set up a custom domain, and explore the dashboard.

  1. Sign up and create your workspace
  2. Add a custom domain under Dashboard → Domains
  3. Create your first link with a branded slug
  4. View real-time analytics on your dashboard

API Reference

REST API for links, domains, analytics, and API key management with scoped permissions.

Authentication

Generate an API key in Dashboard → API Keys. Include it as a Bearer token:

Authorization: Bearer vq_your_key_here

Integrations

Connect Valqor to your CRM, CI/CD pipelines, marketing platforms, and analytics tools.

  • Webhooks — Real-time event notifications (HTTPS only)
  • CSV Import/Export — Bulk link management
  • Conversion Tracking — Pixel-based attribution
  • GA4 — UTM parameter auto-tagging

REST API

API Endpoints

Base URL: https://valqor.app

POST/api/links

Create a new branded link

Example
curl -X POST https://valqor.app/api/links \
  -H "Authorization: Bearer vq_..." \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "go.example.com",
    "slug": "launch",
    "destination": "https://example.com/product",
    "tags": ["marketing", "launch-2025"]
  }'
GET/api/links

List all links in your workspace

Example
curl https://valqor.app/api/links \
  -H "Authorization: Bearer vq_..."
PATCH/api/links/:id

Update an existing link

Example
curl -X PATCH https://valqor.app/api/links/lnk_abc123 \
  -H "Authorization: Bearer vq_..." \
  -H "Content-Type: application/json" \
  -d '{ "destination": "https://example.com/new-page" }'
DELETE/api/links/:id

Delete a link permanently

Example
curl -X DELETE https://valqor.app/api/links/lnk_abc123 \
  -H "Authorization: Bearer vq_..."
GET/api/analytics

Retrieve analytics for your links

Example
curl "https://valqor.app/api/analytics?period=30d" \
  -H "Authorization: Bearer vq_..."
GET/api/domains

List configured custom domains

Example
curl https://valqor.app/api/domains \
  -H "Authorization: Bearer vq_..."

Limits

Rate Limiting

API rate limits are enforced per API key using a sliding window.

Free60 req/min
Pro600 req/min
Business6 000 req/min

Conventions

Response Format

Success

{
  "item": { "id": "lnk_abc123", "slug": "launch", ... }
}

Error

{
  "error": "Slug is already taken",
  "code": "SLUG_COLLISION"
}