Skip to navigation

List

List the short links in your organization, most-followed first.

There is no endpoint that follows a link. Following one counts a click, and a script reading where a link goes is not somebody visiting it: use getBySlug to answer “where does go/roadmap go” without counting, and send people to its shortUrl.

Authentication

AuthorizationBearer

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

Query parameters

qstringOptional

Search links by their short name, description and destination; a draft’s destination only for a key or for those who may edit the link. Every word must appear in one of those fields; case and accents are ignored; at most 100 characters and 8 words. See Searching under Errors and pagination.

searchstringOptionalDeprecated

The older name for q, matched the same way. Deprecated; q wins when both are sent.

draftbooleanOptional

true lists only drafts and false only what is published; left out, both.

archivedbooleanOptional
minebooleanOptional

true lists only your own links, as the console’s My links does: those you created or are named on as an editor. It narrows alongside the other filters. A signed-in session’s are its person’s; an API key’s are its maker’s, the person who created it, and a key whose maker has left the workspace has none and is refused with 403 forbidden.

limitintegerOptional
cursorstringOptional

Response

This endpoint returns an object.
datalist of objects
hasMoreboolean
nextCursorstringOptional

Errors

401
Unauthorized Error
402
Subscription Required Error
403
Forbidden Error
429
Too Many Requests Error