API Documentation

Learn how to integrate with Openn using our REST API

Getting Started

These endpoints are designed for external integration and require API key authentication.

Base URL

Authentication

All API requests must include an API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY

You can generate an API key from your dashboard.

Links API

List Links

GET /api/v1/links

Query Parameters:
- status: 'active' | 'inactive' (optional)
- page: number (optional, default: 1)
- limit: number (optional, default: 10)
- search: string (optional)

Response:
{
  "data": [
    {
      "id": "string",
      "url": "string",
      "title": "string | null",
      "slug": "string",
      "clicks": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "expiresAt": "string | null",
      "validFrom": "string | null",
      "validUntil": "string | null",
      "isActive": "boolean",
      "groupId": "string | null",
      "campaignId": "string | null",
      "restrictions": "object | null",
      "deviceRestrictions": "string | null",
      "locationRestrictions": "string | null",
      "metadata": "string | null"
    }
  ],
  "pagination": {
    "total": "number",
    "page": "number",
    "limit": "number",
    "totalPages": "number"
  }
}

Create Link

POST /api/v1/links

Request Body:
{
  "url": "string",
  "title": "string | null",
  "slug": "string | null",
  "expiresAt": "string | null",
  "password": "string | null",
  "isActive": "boolean | null",
  "deviceRestrictions": "string | null",
  "locationRestrictions": "string | null",
  "groupId": "string | null",
  "campaignId": "string | null",
  "validFrom": "string | null",
  "validUntil": "string | null"
}

Response:
{
  "id": "string",
  "url": "string",
  "title": "string | null",
  "slug": "string",
  "clicks": "number",
  "createdAt": "string",
  "updatedAt": "string",
  "expiresAt": "string | null",
  "validFrom": "string | null",
  "validUntil": "string | null",
  "isActive": "boolean",
  "groupId": "string | null",
  "campaignId": "string | null",
  "restrictions": "object | null",
  "deviceRestrictions": "string | null",
  "locationRestrictions": "string | null",
  "metadata": "string | null"
}