API Reference Overview

The Snip URL API is organized around REST principles. It uses standard HTTP methods, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://snipurl.click/api/v1

All endpoints described in this documentation are relative to this base URL.

Versioning

The API is versioned via the URL path. The current version is v1. When breaking changes are introduced, a new version (v2, v3, etc.) will be released. Existing versions will continue to work for a deprecation period.

Authentication

All API requests require a valid API key passed in the Authorization header:

Authorization: Bearer snip_live_your_key_here

See Authentication for details on creating and managing keys.

HTTP Methods

Request Format

• Request bodies must be JSON with Content-Type: application/json
• Query parameters are used for filtering and pagination on GET requests
• Path parameters are used for identifying specific resources (e.g., /links/:id)

Response Format

Success Response

{
  "success": true,
  "data": { ... }
}

For paginated endpoints, a meta object is included:

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 142,
    "total_pages": 8
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description of the error",
    "details": { ... }
  }
}

Common HTTP Status Codes

Pagination

List endpoints support pagination via query parameters:

Date Formats

All dates in requests and responses use ISO 8601 format with timezone:

2025-06-24T10:00:00.000Z

For date range filters in analytics, use ISO 8601 date strings:

?start=2025-01-01T00:00:00Z&end=2025-06-24T23:59:59Z

Available Endpoints

Links

Analytics

QR Codes

Account