Urlivo
English Français العربية

API reference

Everything you need to authenticate requests, create short links, and read usage data from Urlivo.

Manage API keys Contact

Bearer token auth

Authenticate every request with an API key in the Authorization header.

Plan-based limits

API access, key count, and hourly limits depend on the plan attached to your workspace.

JSON in, JSON out

Send JSON payloads for write actions and expect JSON responses with consistent meta and error objects.

Authentication header

Authorization: Bearer YOUR_API_KEY

Status response example

{
    "data": {
        "name": "Urlivo",
        "version": "v1",
        "docs_url": "https://urlivo.com/developers/api",
        "user": {
            "id": "u_123",
            "email": "hello@example.com",
            "name": "Jane Doe"
        }
    },
    "meta": {}
}

Endpoints

The first API version focuses on link creation, management, workspace usage, and domains.

GET Get API status
/api/v1/status
curl -X GET \
  https://urlivo.com/api/v1/status \
  -H "Authorization: Bearer YOUR_API_KEY"
GET Get workspace usage
/api/v1/me/usage
curl -X GET \
  https://urlivo.com/api/v1/me/usage \
  -H "Authorization: Bearer YOUR_API_KEY"
GET List links
/api/v1/links
curl -X GET \
  "https://urlivo.com/api/v1/links?status=active&sort=newest" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST Create a link
/api/v1/links
curl -X POST \
  https://urlivo.com/api/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target_url": "https://example.com/campaign",
    "slug": "spring24",
    "title": "Spring campaign",
    "domain": "urlivo.com"
  }'
GET Fetch one link
/api/v1/links/{id}
curl -X GET \
  https://urlivo.com/api/v1/links/l_ab12cd34 \
  -H "Authorization: Bearer YOUR_API_KEY"
PATCH Update a link
/api/v1/links/{id}
curl -X PATCH \
  https://urlivo.com/api/v1/links/l_ab12cd34 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Spring campaign 2026",
    "status": "disabled"
  }'
DELETE Delete a link
/api/v1/links/{id}
curl -X DELETE \
  https://urlivo.com/api/v1/links/l_ab12cd34 \
  -H "Authorization: Bearer YOUR_API_KEY"
GET List available domains
/api/v1/domains
curl -X GET \
  https://urlivo.com/api/v1/domains \
  -H "Authorization: Bearer YOUR_API_KEY"

List response example

{
    "data": [
        {
            "id": "l_ab12cd34",
            "short_url": "https://urlivo.com/spring24",
            "domain": "urlivo.com",
            "domain_type": "system",
            "slug": "spring24",
            "title": "Spring campaign",
            "target_url": "https://example.com/campaign",
            "status": "active",
            "clicks": 42,
            "expires_at": "",
            "created_at": "2026-03-09 10:00:00",
            "updated_at": "2026-03-09 10:00:00"
        }
    ],
    "meta": {
        "page": 1,
        "per_page": 20,
        "total": 1,
        "has_more": false
    }
}

Error response example

{
    "error": {
        "code": "invalid_url",
        "message": "Please enter a valid URL starting with http:// or https://.",
        "status": 422,
        "meta": {}
    }
}

Implementation notes