> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.taktoria.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.taktoria.com/_mcp/server.

# Get By Slug

GET https://api.taktoria.com/api/v1/golinks/by-slug/{slug}

One link by its short name: where `go/roadmap` goes, without following
it, so no click is counted. The slug is normalised as on create
(`Q3 Roadmap` finds `q3-roadmap`, and a leading `go/` is dropped). A
nested slug may be sent as it is (`/by-slug/team/roadmap`) or with
its slash encoded (`team%2Froadmap`). Archived links and drafts are
found too; a draft's `url` is null to a signed-in session that may
not edit it. No link by that name in your organization is `404`.

Reference: https://docs.taktoria.com/api-reference/golinks/get-by-slug

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.taktoria.com/api/v1` (Production, default)
- `http://localhost:3000/api/v1` (Local)

## Request

### Path parameters

- `slug` (string, required) — The short name, with or without `go/`.

## Response

### 200

- `id` (string, required)
- `organizationId` (string, required)
- `slug` (string, required) — 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.
- `shortUrl` (string, required) — 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.
- `clicks` (integer, required) — Every follow since the link was made.
- `editorUserIds` (list of string, required) — 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.
- `access` (GoLinkAccess, required) — 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.
- `archived` (boolean, required) — Out of the list, still working. Archiving is about the list, not about breaking a URL somebody has in a document somewhere.
- `draft` (boolean, required) — 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.
- `createdAt` (datetime, required)
- `updatedAt` (datetime, required)
- `url` (string, optional) — 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.
- `description` (string, optional)
- `lastUsedAt` (datetime, optional)
- `createdBy` (User, optional) — A person in a Taktoria organization.
- `archivedAt` (datetime, optional)

## Errors

### 404 Not Found Error

- `error` (ErrorDetail, required)

### 402 Subscription Required Error

The organization has no subscription for the app that lets it in: active, trialing or past due. One that is unpaid (Stripe stopped retrying a failed payment), paused, incomplete or cancelled answers this too, and the message says which: an unpaid app is locked until a workspace admin updates the payment details. `details.status` is the app's subscription status (null with none), and `details.paymentIssue` is `unpaid`, or `payment_failed` for an incomplete one whose first payment failed, as `paymentIssue` on `GET /subscription` reckons it; null when a payment is not why.

- `error` (ErrorDetail, required)

### 429 Too Many Requests Error

Rate limited (`rate_limited`): the key, the signed-in person, the workspace or an expensive endpoint's own budget is used up for now. `Retry-After` says how many seconds to wait, and `details` names the `policy`, its `limit`, `windowSeconds` and `retryAfter`. Every answer to an authenticated request carries the IETF `RateLimit-Policy` and `RateLimit` headers, so a client can slow down before it gets this. Nothing was done; wait and send it again. See "Rate limits".

- `error` (ErrorDetail, required)

## Types

### GoLinkAccess

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.

- `audience` (enum, required) — Who may follow a link on the workspace's Go Links hostname. On our own `/go/…` a link always takes a member signed in, whatever this says.
  - Allowed values: `PUBLIC`, `WORKSPACE`, `DOMAIN`
- `requireGoogle` (boolean, required) — For `DOMAIN`, addresses are proved only by Google, never by a code. The rule as it applies: true whenever the workspace requires Google sign-in, whatever was set on the link.
- `domains` (list of string, optional) — For `DOMAIN`: the email domains let in, chosen from the workspace's allow-list (its verified domains left on it, and its partner domains: see `/partner-domains`). Only those still on the list count, as it is at the time; empty means the whole list, and with nothing on it only members can follow the link. An address at a subdomain counts. Kept, unused, under another audience. Null when called with a signed-in session by somebody who may not edit the link; a key always sees them.

### User

A person in a Taktoria organization.

- `id` (string, required)
- `name` (string, required)
- `email` (string, required)
- `image` (string, optional) — Their picture: one uploaded on the account page, or else their Google profile picture, brought in when they sign in with Google.

### ErrorDetail

- `code` (string, required) — A stable machine-readable code such as `not_found`.
- `message` (string, required)
- `details` (any, optional)

## Examples

**Response**

```json
{
  "id": "gol_7f3a",
  "organizationId": "org_1",
  "slug": "roadmap",
  "shortUrl": "https://go.example.com/roadmap",
  "clicks": 412,
  "editorUserIds": [],
  "access": {
    "audience": "DOMAIN",
    "requireGoogle": false,
    "domains": []
  },
  "archived": false,
  "draft": false,
  "createdAt": "2026-04-01T12:00:00Z",
  "updatedAt": "2026-04-20T12:00:00Z",
  "url": "https://example.com/roadmap"
}
```

**SDK Code**

```python
import requests

url = "https://api.taktoria.com/api/v1/golinks/by-slug/roadmap"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.taktoria.com/api/v1/golinks/by-slug/roadmap';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taktoria.com/api/v1/golinks/by-slug/roadmap"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.taktoria.com/api/v1/golinks/by-slug/roadmap")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.taktoria.com/api/v1/golinks/by-slug/roadmap")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.taktoria.com/api/v1/golinks/by-slug/roadmap', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.taktoria.com/api/v1/golinks/by-slug/roadmap");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.taktoria.com/api/v1/golinks/by-slug/roadmap")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```