Skip to Content

API Reference

The Codelloy API allows you to programmatically create, update, and manage shortened URLs for your organization. All API endpoints are authenticated via an API key and follow a consistent JSON response envelope.

Base URL

All API requests are made to the following base URL:

https://api.codelloy.com/link/external/v1

Response Envelope

Every API response is wrapped in a standard CodelloyResponse envelope:

{
  "response": { /* result payload */ }
}
  • response — Contains the result payload on success. Omitted from the JSON when the request fails.
  • errors — A non-empty array of error objects on failure. Omitted on success. Each entry carries code, message, and an optional structured details payload (used by quota, rate-limit, and deep-link validation errors).
{
  "errors": [
    {
      "code": "VE001",
      "message": "shortCode: must contain only alphanumeric characters, hyphens, and underscores"
    }
  ]
}

Sections

Explore each section for detailed documentation:

  • Authentication — How API key authentication works
  • Obtaining Your API Key — Step-by-step guide to generate, label, and manage your API key from the dashboard
  • Mobile Apps — Register your iOS and Android apps to obtain mobileAppId values for deep-link entries
  • Quick Start — End-to-end example to create your first short link
  • Endpoints — Create, update, bulk save, and list shortened URLs (including deep links)
  • Rate Limiting — Request limits and best practices
  • API Errors — Error codes, HTTP status codes, and detailed error scenarios
  • Field Reference — Complete request/response field reference
Last updated on
AnalyticsAuthentication