Create short link

curl --request POST \
  --url https://api.h0p.co/short-link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "domain": "links.example.com",
  "slug": "summer-sale",
  "destination": {
    "type": "link",
    "value": "https://example.com/products/summer-sale",
    "threatTypes": null
  },
  "tags": [
    "marketing",
    "sale"
  ],
  "folderId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "maxClicks": 1000,
  "expiresAt": "2024-12-31T23:59:59Z"
}
'

import requests

url = "https://api.h0p.co/short-link"

payload = {
    "domain": "links.example.com",
    "slug": "summer-sale",
    "destination": {
        "type": "link",
        "value": "https://example.com/products/summer-sale",
        "threatTypes": None
    },
    "tags": ["marketing", "sale"],
    "folderId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "maxClicks": 1000,
    "expiresAt": "2024-12-31T23:59:59Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'links.example.com',
    slug: 'summer-sale',
    destination: {
      type: 'link',
      value: 'https://example.com/products/summer-sale',
      threatTypes: null
    },
    tags: ['marketing', 'sale'],
    folderId: '01933eb8-541f-7000-a9f4-e4eee80ff04e',
    maxClicks: 1000,
    expiresAt: '2024-12-31T23:59:59Z'
  })
};

fetch('https://api.h0p.co/short-link', 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://api.h0p.co/short-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'links.example.com',
    'slug' => 'summer-sale',
    'destination' => [
        'type' => 'link',
        'value' => 'https://example.com/products/summer-sale',
        'threatTypes' => null
    ],
    'tags' => [
        'marketing',
        'sale'
    ],
    'folderId' => '01933eb8-541f-7000-a9f4-e4eee80ff04e',
    'maxClicks' => 1000,
    'expiresAt' => '2024-12-31T23:59:59Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.h0p.co/short-link"

	payload := strings.NewReader("{\n  \"domain\": \"links.example.com\",\n  \"slug\": \"summer-sale\",\n  \"destination\": {\n    \"type\": \"link\",\n    \"value\": \"https://example.com/products/summer-sale\",\n    \"threatTypes\": null\n  },\n  \"tags\": [\n    \"marketing\",\n    \"sale\"\n  ],\n  \"folderId\": \"01933eb8-541f-7000-a9f4-e4eee80ff04e\",\n  \"maxClicks\": 1000,\n  \"expiresAt\": \"2024-12-31T23:59:59Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.h0p.co/short-link")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"links.example.com\",\n  \"slug\": \"summer-sale\",\n  \"destination\": {\n    \"type\": \"link\",\n    \"value\": \"https://example.com/products/summer-sale\",\n    \"threatTypes\": null\n  },\n  \"tags\": [\n    \"marketing\",\n    \"sale\"\n  ],\n  \"folderId\": \"01933eb8-541f-7000-a9f4-e4eee80ff04e\",\n  \"maxClicks\": 1000,\n  \"expiresAt\": \"2024-12-31T23:59:59Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.h0p.co/short-link")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"links.example.com\",\n  \"slug\": \"summer-sale\",\n  \"destination\": {\n    \"type\": \"link\",\n    \"value\": \"https://example.com/products/summer-sale\",\n    \"threatTypes\": null\n  },\n  \"tags\": [\n    \"marketing\",\n    \"sale\"\n  ],\n  \"folderId\": \"01933eb8-541f-7000-a9f4-e4eee80ff04e\",\n  \"maxClicks\": 1000,\n  \"expiresAt\": \"2024-12-31T23:59:59Z\"\n}"

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

{
  "domain": {
    "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "domain": "links.example.com",
    "isPrimary": true,
    "isVerified": true,
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "rules": [
    {
      "priority": 0,
      "destination": {
        "type": "link",
        "value": "https://example.com",
        "threatTypes": null
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "countries": [
        "US",
        "CA",
        "GB"
      ],
      "languages": [
        "en",
        "fr",
        "es-MX"
      ],
      "osTypes": [
        "ios",
        "android"
      ]
    }
  ],
  "qrCode": {
    "options": {
      "data": "https://example.com/abc123",
      "type": "svg",
      "width": 300,
      "height": 300,
      "margin": 4,
      "image": "https://example.com/logo.png",
      "imageOptions": {
        "hideBackgroundDots": true,
        "imageSize": 0.4,
        "crossOrigin": "anonymous",
        "margin": 10
      },
      "dotsOptions": {
        "type": "rounded",
        "color": "#000000",
        "gradient": {
          "type": "linear",
          "colorStops": [
            {
              "offset": 0,
              "color": "#3B82F6"
            },
            {
              "offset": 1,
              "color": "#8B5CF6"
            }
          ],
          "rotation": 45
        },
        "roundSize": true
      },
      "cornersSquareOptions": {
        "type": "square",
        "color": "#3B82F6",
        "gradient": {
          "type": "linear",
          "colorStops": [
            {
              "offset": 0,
              "color": "#3B82F6"
            },
            {
              "offset": 1,
              "color": "#8B5CF6"
            }
          ],
          "rotation": 45
        }
      },
      "cornersDotOptions": {
        "type": "dot",
        "color": "#8B5CF6",
        "gradient": {
          "type": "linear",
          "colorStops": [
            {
              "offset": 0,
              "color": "#3B82F6"
            },
            {
              "offset": 1,
              "color": "#8B5CF6"
            }
          ],
          "rotation": 45
        }
      },
      "backgroundOptions": {
        "round": 0.1,
        "color": "#FFFFFF"
      }
    },
    "imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e"
  },
  "destination": {
    "type": "link",
    "value": "https://example.com",
    "threatTypes": null
  },
  "metaTags": {
    "title": "Amazing Product Launch 2024",
    "description": "Be the first to discover our revolutionary new product.",
    "imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "image": {
      "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
      "key": "meta-tag/01933eb8-541f-7000-a9f4-e4eee80ff04e.png"
    }
  },
  "tags": [
    {
      "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
      "name": "social-media",
      "color": "#10B981"
    }
  ],
  "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "organizationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "isActive": true,
  "qrCodeId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "domainId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "folderId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "slug": "summer-sale",
  "originUrl": "https://links.example.com/summer-sale",
  "expiresAt": "2024-12-31T23:59:59Z",
  "maxClicks": 1000,
  "currentClicks": 247,
  "hasPassword": false,
  "cloaking": false,
  "destinationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:20:00Z"
}

{
  "code": "PLAN_LIMIT_REACHED",
  "message": "You have reached the maximum number of domains for your plan."
}

{
  "code": "VALIDATION_ERROR",
  "message": "The provided slug is already in use"
}

{
  "code": "VALIDATION_ERROR",
  "message": "The provided slug is already in use"
}

POST

short-link

Create short link

curl --request POST \
  --url https://api.h0p.co/short-link \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "domain": "links.example.com",
  "slug": "summer-sale",
  "destination": {
    "type": "link",
    "value": "https://example.com/products/summer-sale",
    "threatTypes": null
  },
  "tags": [
    "marketing",
    "sale"
  ],
  "folderId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "maxClicks": 1000,
  "expiresAt": "2024-12-31T23:59:59Z"
}
'

import requests

url = "https://api.h0p.co/short-link"

payload = {
    "domain": "links.example.com",
    "slug": "summer-sale",
    "destination": {
        "type": "link",
        "value": "https://example.com/products/summer-sale",
        "threatTypes": None
    },
    "tags": ["marketing", "sale"],
    "folderId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "maxClicks": 1000,
    "expiresAt": "2024-12-31T23:59:59Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'links.example.com',
    slug: 'summer-sale',
    destination: {
      type: 'link',
      value: 'https://example.com/products/summer-sale',
      threatTypes: null
    },
    tags: ['marketing', 'sale'],
    folderId: '01933eb8-541f-7000-a9f4-e4eee80ff04e',
    maxClicks: 1000,
    expiresAt: '2024-12-31T23:59:59Z'
  })
};

fetch('https://api.h0p.co/short-link', 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://api.h0p.co/short-link",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'links.example.com',
    'slug' => 'summer-sale',
    'destination' => [
        'type' => 'link',
        'value' => 'https://example.com/products/summer-sale',
        'threatTypes' => null
    ],
    'tags' => [
        'marketing',
        'sale'
    ],
    'folderId' => '01933eb8-541f-7000-a9f4-e4eee80ff04e',
    'maxClicks' => 1000,
    'expiresAt' => '2024-12-31T23:59:59Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.h0p.co/short-link"

	payload := strings.NewReader("{\n  \"domain\": \"links.example.com\",\n  \"slug\": \"summer-sale\",\n  \"destination\": {\n    \"type\": \"link\",\n    \"value\": \"https://example.com/products/summer-sale\",\n    \"threatTypes\": null\n  },\n  \"tags\": [\n    \"marketing\",\n    \"sale\"\n  ],\n  \"folderId\": \"01933eb8-541f-7000-a9f4-e4eee80ff04e\",\n  \"maxClicks\": 1000,\n  \"expiresAt\": \"2024-12-31T23:59:59Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.h0p.co/short-link")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"links.example.com\",\n  \"slug\": \"summer-sale\",\n  \"destination\": {\n    \"type\": \"link\",\n    \"value\": \"https://example.com/products/summer-sale\",\n    \"threatTypes\": null\n  },\n  \"tags\": [\n    \"marketing\",\n    \"sale\"\n  ],\n  \"folderId\": \"01933eb8-541f-7000-a9f4-e4eee80ff04e\",\n  \"maxClicks\": 1000,\n  \"expiresAt\": \"2024-12-31T23:59:59Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.h0p.co/short-link")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"links.example.com\",\n  \"slug\": \"summer-sale\",\n  \"destination\": {\n    \"type\": \"link\",\n    \"value\": \"https://example.com/products/summer-sale\",\n    \"threatTypes\": null\n  },\n  \"tags\": [\n    \"marketing\",\n    \"sale\"\n  ],\n  \"folderId\": \"01933eb8-541f-7000-a9f4-e4eee80ff04e\",\n  \"maxClicks\": 1000,\n  \"expiresAt\": \"2024-12-31T23:59:59Z\"\n}"

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

{
  "domain": {
    "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "domain": "links.example.com",
    "isPrimary": true,
    "isVerified": true,
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "rules": [
    {
      "priority": 0,
      "destination": {
        "type": "link",
        "value": "https://example.com",
        "threatTypes": null
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "countries": [
        "US",
        "CA",
        "GB"
      ],
      "languages": [
        "en",
        "fr",
        "es-MX"
      ],
      "osTypes": [
        "ios",
        "android"
      ]
    }
  ],
  "qrCode": {
    "options": {
      "data": "https://example.com/abc123",
      "type": "svg",
      "width": 300,
      "height": 300,
      "margin": 4,
      "image": "https://example.com/logo.png",
      "imageOptions": {
        "hideBackgroundDots": true,
        "imageSize": 0.4,
        "crossOrigin": "anonymous",
        "margin": 10
      },
      "dotsOptions": {
        "type": "rounded",
        "color": "#000000",
        "gradient": {
          "type": "linear",
          "colorStops": [
            {
              "offset": 0,
              "color": "#3B82F6"
            },
            {
              "offset": 1,
              "color": "#8B5CF6"
            }
          ],
          "rotation": 45
        },
        "roundSize": true
      },
      "cornersSquareOptions": {
        "type": "square",
        "color": "#3B82F6",
        "gradient": {
          "type": "linear",
          "colorStops": [
            {
              "offset": 0,
              "color": "#3B82F6"
            },
            {
              "offset": 1,
              "color": "#8B5CF6"
            }
          ],
          "rotation": 45
        }
      },
      "cornersDotOptions": {
        "type": "dot",
        "color": "#8B5CF6",
        "gradient": {
          "type": "linear",
          "colorStops": [
            {
              "offset": 0,
              "color": "#3B82F6"
            },
            {
              "offset": 1,
              "color": "#8B5CF6"
            }
          ],
          "rotation": 45
        }
      },
      "backgroundOptions": {
        "round": 0.1,
        "color": "#FFFFFF"
      }
    },
    "imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e"
  },
  "destination": {
    "type": "link",
    "value": "https://example.com",
    "threatTypes": null
  },
  "metaTags": {
    "title": "Amazing Product Launch 2024",
    "description": "Be the first to discover our revolutionary new product.",
    "imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "image": {
      "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
      "key": "meta-tag/01933eb8-541f-7000-a9f4-e4eee80ff04e.png"
    }
  },
  "tags": [
    {
      "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
      "name": "social-media",
      "color": "#10B981"
    }
  ],
  "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "organizationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "isActive": true,
  "qrCodeId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "domainId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "folderId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "slug": "summer-sale",
  "originUrl": "https://links.example.com/summer-sale",
  "expiresAt": "2024-12-31T23:59:59Z",
  "maxClicks": 1000,
  "currentClicks": 247,
  "hasPassword": false,
  "cloaking": false,
  "destinationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:20:00Z"
}

{
  "code": "PLAN_LIMIT_REACHED",
  "message": "You have reached the maximum number of domains for your plan."
}

{
  "code": "VALIDATION_ERROR",
  "message": "The provided slug is already in use"
}

{
  "code": "VALIDATION_ERROR",
  "message": "The provided slug is already in use"
}

Authorizations

x-api-key

string

header

required

API Key authentication for programmatic access.

How to use:

Create an API key from your dashboard settings
Include the key in the x-api-key header with each request
API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)

Example:

curl -H "x-api-key: your-api-key-here" https://api.h0p.co/short-link/list

Types of API keys:

User keys: Linked to your user account (one per organization)
Bot keys: Autonomous machine users (one per organization)

Security notes:

Keep your API keys secure and never commit them to version control
API keys cannot access authentication endpoints (/auth/*)
Keys can be revoked at any time from the dashboard

Body

application/json

Short link configuration with destination and optional features

Short link creation/update request

destination

object

required

Main destination URL/email/phone

Show child attributes

Example:

{
  "type": "link",
  "value": "https://example.com",
  "threatTypes": null
}

domainId

string<uuid>

UUID of the domain to use

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

domain

string

Domain name to use (alternative to domainId)

Example:

"links.example.com"

folderId

string<uuid> | null

UUID of folder to organize link

Example:

"01933eb8-541f-7000-a9f4-e4eee80ff04e"

Response

Short link created successfully

Complete short link with all nested objects

domain

object

required

Domain details

Show child attributes

rules

object[]

required

Smart routing rules with IDs

Show child attributes

qrCode

object | null

required

QR code configuration

Show child attributes

destination

object | null

required

Main destination configuration

Show child attributes

Example:

{
  "type": "link",
  "value": "https://example.com",
  "threatTypes": null
}

metaTags

object | null

required

Meta tags configuration

Show child attributes

Example:

{
  "title": "Amazing Product Launch 2024",
  "description": "Be the first to discover our revolutionary new product.",
  "imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
  "image": {
    "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "key": "meta-tag/01933eb8-541f-7000-a9f4-e4eee80ff04e.png"
  }
}

Getting Started

Endpoints

Create short link

Authorizations

Body

Response