Skip to navigation
API ReferenceGolinks

Get

Authentication

AuthorizationBearer

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

Path parameters

linkIdstringRequired

Response

This endpoint returns an object.
idstring
organizationIdstring
slugstring

The bit after go/. Normalised hard on the way in: lowercase, with spaces and underscores folded to hyphens, because the whole value of go/roadmap is that a colleague can guess it.

shortUrlstring

The address to hand out: on the workspace’s own Go Links hostname where it has one (https://go.acme.com/roadmap), otherwise this installation’s /go/roadmap, which asks a member to sign in. What the link’s QR code (qrCode) holds: the short link, never the destination, so re-pointing the link breaks nothing printed.

clicksinteger
Every follow since the link was made.
editorUserIdslist of strings

Who may change it, when it is not simply anybody with a seat, beside its creator and Go Links’ app admins, who always may. Empty means no restriction, which is what every link is until somebody narrows it. A Viewer of Go Links changes no link, named or not. Never affects who may follow a link: that is access. Members of the workspace when they were named; somebody since removed from it stays listed until the link’s editors are saved again.

accessobject

Who may follow this link on the Go Links hostname, as a Dory event’s audience says who may join it. There is no “anyone signed in”: anybody can make an account, so for links it would be no check at all. A link made without saying is DOMAIN with no domains listed.

archivedboolean
Out of the list, still working. Archiving is about the list, not about breaking a URL somebody has in a document somewhere.
draftboolean
Holds the slug without redirecting. Nobody else can take the name, but following it opens Go Links instead of the destination, and counts no click, until the link is published.
createdAtdatetime
updatedAtdatetime
urlstringOptional

Where it goes. Null for a draft when called with a signed-in session by somebody who may not edit the link: a draft’s destination is its editors’ business. A key always sees it.

descriptionstringOptional
lastUsedAtdatetimeOptional
createdByobjectOptional
A person in a Taktoria organization.
archivedAtdatetimeOptional

Errors

404
Not Found Error
429
Too Many Requests Error