Skip to main content
GET
List links

Authorizations

Authorization
string
header
required

Workspace API key, sent as Authorization: Bearer lk_live_….

Query Parameters

page
integer
default:1

1-based page number.

Required range: x >= 1
limit
integer
default:20

Rows per page.

Required range: x >= 1

Case-insensitive match against title, destination URL, description, short code and short URL.

utmSource
string

Comma-separated list of utm_source values to include.

utmMedium
string

Comma-separated list of utm_medium values to include.

archived
enum<string>
default:false

true returns archived links instead of active ones. Any other value returns active links.

Available options:
true,
false
folderId
string

Comma-separated folder IDs. The literal value unsorted matches links with no folder.

tagIds
string

Comma-separated tag IDs. A link matches if it carries any of them.

dateFrom
string<date-time>

Only links created at or after this instant.

dateTo
string<date-time>

Only links created at or before this instant.

orderBy
enum<string>
default:date_created

Sort order.

Available options:
date_created,
date_updated,
clicks,
title

Response

A page of links.

pagination
object

Offset pagination. Used by GET /links and GET /tags/{id}/links.