List Links

GET

links

List links

curl --request GET \
  --url https://{environment}.shortpen.com/v1/links \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{environment}.shortpen.com/v1/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{environment}.shortpen.com/v1/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{environment}.shortpen.com/v1/links"

	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(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{environment}.shortpen.com/v1/links")

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

{
  "success": true,
  "status_code": 200,
  "data": [
    {
      "id": 501,
      "url": "https://example.com/launch",
      "link": "https://go.shortpen.com/summer-2025",
      "short_url": "https://go.shortpen.com/summer-2025",
      "starred": false,
      "redirect_type": 301,
      "domain_id": 3,
      "workspace_id": 24,
      "organization_id": 3,
      "link_cloak": false,
      "hide_referer": false,
      "with_password": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "title": "Launch landing page",
      "qr": "<string>",
      "folder_id": 42,
      "pixel_id": 123,
      "source_id": 123,
      "params": {},
      "social_share_title": "<string>",
      "social_share_description": "<string>",
      "social_share_image": "<string>"
    }
  ],
  "count": 25,
  "total": 142,
  "page": 1,
  "message": ""
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

Returns a paginated list of links belonging to the workspace associated with your API token. Use this endpoint to browse existing links, retrieve id values for editing, or synchronise link data with external systems.

The id field in each returned item is the url_id you need when calling the Edit Link endpoint.

Query parameters

Parameter	Type	Default	Description
`page`	integer	`1`	Page number (1-based).
`limit`	integer	`100`	Links per page. Maximum `100`.
`workspace_id`	integer	first workspace	Workspace to scope results to.

Response payload

The response uses the standard envelope and adds pagination metadata:

data — array of link objects (see schema below).
count — number of items in the current page.
total — total number of links matching the query.
page — current page number.

Link object fields

Each item in data exposes the following properties:

Field	Type	Description
`id`	integer	Unique link identifier.
`title`	string	Human-friendly title (if set).
`url`	string	Destination URL.
`link`	string	Fully qualified link (domain + slug).
`short_url`	string	Deprecated — same value as `link`. Will be removed in a future version; migrate to `link`.
`qr`	string \| null	Base64 QR code PNG if generated.
`starred`	boolean	Whether the link is starred.
`redirect_type`	integer	`301` or `302`.
`domain_id`	integer	Domain hosting the link.
`folder_id`	integer \| null	Folder assignment.
`pixel_id`	integer \| null	Associated tracking pixel.
`workspace_id`	integer	Owning workspace.
`organization_id`	integer	Owning organization.
`link_cloak`	boolean	Whether URL cloaking is active.
`hide_referer`	boolean	Whether the referrer header is removed.
`with_password`	boolean	Whether the link is password-protected.
`params`	object \| null	Query parameters appended to the destination.
`social_share_title`	string \| null	Custom OpenGraph title.
`social_share_description`	string \| null	Custom OpenGraph description.
`social_share_image`	string \| null	Social preview image URL.
`created_at`	string (ISO 8601)	When the link was created.
`updated_at`	string (ISO 8601)	When the link was last modified.

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

default:1

Page number for pagination.

Required range: x >= 1

limit

integer

default:100

Number of links per page (max 100).

Required range: 1 <= x <= 100

workspace_id

integer

Workspace ID to scope results. Defaults to the first workspace when omitted.

Response

Paginated list of links

success

boolean

required

Example:

true

status_code

integer

required

Example:

200

data

object[]

required

Show child attributes

count

integer

required

Number of links returned in the current page.

Example:

25

total

integer

required

Total number of links matching the query.

Example:

142

page

integer

required

Current page number.

Example:

1

message

string

Example:

""

List links

curl --request GET \
  --url https://{environment}.shortpen.com/v1/links \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{environment}.shortpen.com/v1/links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{environment}.shortpen.com/v1/links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{environment}.shortpen.com/v1/links"

	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(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{environment}.shortpen.com/v1/links")

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

{
  "success": true,
  "status_code": 200,
  "data": [
    {
      "id": 501,
      "url": "https://example.com/launch",
      "link": "https://go.shortpen.com/summer-2025",
      "short_url": "https://go.shortpen.com/summer-2025",
      "starred": false,
      "redirect_type": 301,
      "domain_id": 3,
      "workspace_id": 24,
      "organization_id": 3,
      "link_cloak": false,
      "hide_referer": false,
      "with_password": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "title": "Launch landing page",
      "qr": "<string>",
      "folder_id": 42,
      "pixel_id": 123,
      "source_id": 123,
      "params": {},
      "social_share_title": "<string>",
      "social_share_description": "<string>",
      "social_share_image": "<string>"
    }
  ],
  "count": 25,
  "total": 142,
  "page": 1,
  "message": ""
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

{
  "success": false,
  "status_code": 401,
  "message": "There was an error while processing your request.",
  "data": "<unknown>"
}

API reference

Core

Links

Resources

Query parameters

Response payload

Link object fields

Authorizations

Query Parameters

Response

​Query parameters

​Response payload

​Link object fields

Authorizations

Query Parameters

Response

Query parameters

Response payload

Link object fields