Quick Start

Get up and running with the Codelloy API in under 5 minutes. This guide walks you through creating your first short link end-to-end.

Step 0 — Register your mobile apps (if using deep links)

Skip this step if you only need plain web redirects. Otherwise: register your iOS and Android apps on the Codelloy dashboard so you can reference them in deepLinks[]. See Mobile Apps for the full walkthrough — it takes ~2 minutes and you can copy the per-platform mobileAppId directly from the dashboard.

Step 1 — Get your API key

1. Sign in to the Codelloy Dashboard .
2. Navigate to API Key in the sidebar (under General).
3. Click Generate Key — optionally give it a label (3–100 chars, letters / numbers / spaces / . , _ - ( )) so audit-log entries are easy to identify (e.g. "Production Integration"). API-created links appear in the dashboard with createdBy = api-key:<your label>.
4. Copy the key and store it securely. The key is shown only once — there is no way to retrieve it later, only regenerate.

See Obtaining Your API Key for screenshots and the label-edit flow.

Step 2 — Create your first short link

Replace your_api_key_here with the key from Step 1:

curl -X POST https://api.codelloy.com/link/external/v1/shortenedUrl/save \
  -H "X-API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/my-long-article-url",
    "shortCode": "my-first-link",
    "shortLinkName": "My First Codelloy Link"
  }'

Expected response:

{
  "response": {
    "url": "https://example.com/my-long-article-url",
    "shortCode": "my-first-link",
    "shortLinkName": "My First Codelloy Link",
    "smartLink": "https://re.codelloy.com/my-first-link",
    "isActive": true,
    "createdAt": "2026-05-15T10:30:00",
    "updatedAt": "2026-05-15T10:30:00",
    "createdBy": "api-key:Production Integration",
    "updatedBy": "api-key:Production Integration",
    "createdVia": "EXTERNAL",
    "lastModifiedVia": "EXTERNAL"
  }
}

The smartLink value reflects your active custom domain when one is set; otherwise it defaults to https://re.codelloy.com/<shortCode>. See Custom Domains for details.

Step 3 — Verify your link

List your links to confirm:

curl -X GET "https://api.codelloy.com/link/external/v1/shortenedUrl?page=0&size=10" \
  -H "X-API-KEY: your_api_key_here"

The response envelope wraps a data[] array and a page metadata block:

{
  "response": {
    "data": [
      { "shortCode": "my-first-link", "url": "https://example.com/my-long-article-url", "smartLink": "https://re.codelloy.com/my-first-link", "isActive": true }
    ],
    "page": { "size": 10, "number": 0, "totalElements": 1, "totalPages": 1 }
  }
}

Step 4 — Share your link

Use the smartLink value from the response to share your shortened URL:

https://re.codelloy.com/my-first-link

Visitors who open this URL are redirected to https://example.com/my-long-article-url.

What’s next?

• Mobile Apps — register your apps so you can attach deepLinks[] to your short URLs.
• Endpoints — full request and response schemas including bulk create, list, and the deep-link payload.
• Field Reference — every field, type, and constraint.
• API Errors — error codes and how to handle them.