Short URLs

Reserve a short URL code

Generates and reserves a unique 5-character short code for the authenticated user. The reserved code can later be used when creating a QR code or short URL. Useful for pre-allocating codes before the destination URL is known.

get/short-url/reserved

Request

  • Base URL: https://api.qrcodly.de/api/v1
  • URL: https://api.qrcodly.de/api/v1/short-url/reserved
  • Auth: HTTP bearer

Response

Default Response

idstring uuid required

Unique identifier (UUID v4)

createdAtstring date-time required

Timestamp when the resource was created (ISO 8601)

updatedAtstring date-time nullable required

Timestamp when the resource was last updated (ISO 8601), or null if never updated

shortCodestring required

Unique 5-character short code (e.g. "Ab3xZ")

namestring nullable required

User-defined name for the short URL (max 50 characters)

destinationUrlstring uri nullable required

The target URL that the short URL redirects to

qrCodeIdstring uuid nullable required

ID of the linked QR code, or null for standalone short URLs

isActiveboolean required

Whether the short URL is currently active and redirecting

createdBystring required

User ID of the short URL owner

deletedAtstring date-time nullable required

Soft-delete timestamp, or null if the short URL is active

safetyStatus'unchecked' | 'clean' | 'blocked' required

Result of the destination safety screening. "blocked" means we disabled the link and the owner cannot re-enable it

safetyBlockedAtstring date-time nullable required

When the link was blocked for safety reasons, or null

safetyThreatTypesstring nullable required

Comma-separated Google Web Risk threat types behind the block, or null

shortUrlstring required

Fully-built short URL for the reserved code (redirect domain or custom domain).

Changes

No recorded changes to this operation across all 1 revision of this API.