Field Reference

Complete reference of all data objects returned by the LinkShark API.

Short URL Object

This is the primary object returned by the /link/external/v1/save, /link/external/v1/bulkSave, and list endpoints.

Field	Type	Nullable	Description
`id`	string	No	Unique identifier (UUID) for the short URL record.
`url`	string	No	The original destination URL.
`shortCode`	string	No	The unique alias used in the short link.
`smartLink`	string	No	The full shortened URL (e.g., `https://lnk.shark/my-link`).
`title`	string	Yes	Descriptive title for the link.
`iosDeeplinkUrl`	string	Yes	iOS deep link URL for in-app routing.
`iosFallbackUrl`	string	Yes	Fallback URL for iOS when the app is not installed.
`androidDeeplinkUrl`	string	Yes	Android deep link URL for in-app routing.
`androidFallbackUrl`	string	Yes	Fallback URL for Android when the app is not installed.
`expirationDate`	string	Yes	ISO 8601 timestamp when the link expires.
`password`	string	Yes	Password protecting the link (if set).
`isActive`	boolean	No	Whether the link is currently active and resolvable.
`totalClicks`	integer	No	Total number of times the short link has been accessed.
`tags`	string[]	Yes	Array of tag labels for organizing links.
`qrCodeUrl`	string	Yes	URL to the auto-generated QR code image for this link.
`createdAt`	string	No	ISO 8601 timestamp of when the record was created.
`updatedAt`	string	No	ISO 8601 timestamp of the last update.
`orgId`	string	No	Organization ID that owns this short URL.

Note: Nullable fields are omitted from the response when their value is null.

Returned by the list endpoint wrapping the results array.

Field	Type	Description
`content`	array	Array of Short URL Objects for the current page.
`totalPages`	integer	Total number of pages available.
`totalElements`	integer	Total number of records matching the query.
`currentPage`	integer	Current page number (zero-based).
`pageSize`	integer	Number of records per page.