Skip to main content
GET
Retrieve shortcut

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

handle
string
required

The shortcut's slug or id (UUID).

Response

The shortcut.

A shortcut.

id
string<uuid>
required

The shortcut's unique ID.

slug
string
required

The shortcut slug.

url
string
required

Workspace-scoped short link. Open this URL to record a click and redirect to the destination.

Example:

"https://app.uselora.com/acme/short/handbook"

destination
string
required

The destination URL of the short link.

title
string | null
required
description
string | null
required
icon
string | null
required
image
string | null
required
video
string | null
required
visibility
enum<string>
required
Available options:
PRIVATE,
WORKSPACE,
UNLISTED,
PUBLIC
archived
boolean
required

Whether the short link is archived. Defaults to false if not provided.

masked
boolean
required
passwordProtected
boolean
required

Whether this shortcut requires a password before redirecting. The password hash is never returned.

expiresAt
string | null
required

The date and time when the short link will expire at.

ios
string | null
required

The iOS destination URL for the shortcut for iOS device targeting.

android
string | null
required

The Android destination URL for the shortcut for Android device targeting.

geo
Geo · object | null
required

Geo targeting information for the short link in JSON format {[COUNTRY]: https://example.com }

placeholders
PlaceholderDescriptor · object[]
required

Dynamic placeholders parsed from the destination URL. Empty for static destinations. See docs/dynamic-placeholders.md.

folderId
string
required

The 8-character ID of the folder this shortcut belongs to.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

tagIds
string[]
required

The unique IDs of the tags assigned to the shortcut.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:
externalId
string | null
required

The ID of the link in your database. If set, it can be used to identify the link in future API requests (the ext_ prefix is recommended on query parameters for visual disambiguation but the server accepts both prefixed and bare values). This key is unique across your workspace.

tenantId
string | null
required

The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.

comments
string | null
required

The comments for the short link.

workspaceId
string
required

ID of the workspace the shortcut belongs to.

userId
string
required

ID of the user who created the shortcut.

createdAt
string
required

ISO 8601 creation timestamp.

updatedAt
string
required

ISO 8601 timestamp of the last update.