Create folder
curl --request POST \
--url https://api.h0p.co/folder \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Marketing Campaign 2024",
"color": "#3B82F6"
}
'import requests
url = "https://api.h0p.co/folder"
payload = {
"name": "Marketing Campaign 2024",
"color": "#3B82F6"
}
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({name: 'Marketing Campaign 2024', color: '#3B82F6'})
};
fetch('https://api.h0p.co/folder', 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/folder",
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([
'name' => 'Marketing Campaign 2024',
'color' => '#3B82F6'
]),
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/folder"
payload := strings.NewReader("{\n \"name\": \"Marketing Campaign 2024\",\n \"color\": \"#3B82F6\"\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/folder")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Marketing Campaign 2024\",\n \"color\": \"#3B82F6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.h0p.co/folder")
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 \"name\": \"Marketing Campaign 2024\",\n \"color\": \"#3B82F6\"\n}"
response = http.request(request)
puts response.read_body{
"id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"organizationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"name": "Marketing Campaign 2024",
"color": "#3B82F6",
"isDefault": false,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-16T14:20:00Z"
}{
"code": "FOLDER_LIMIT_REACHED",
"message": "You have reached the maximum number of folders (50) for your plan. Upgrade to increase your limit."
}{
"code": "ALREADY_EXIST"
}Folder
Create folder
Create a new folder to organize short links. Folders help categorize links and track statistics by group.
POST
/
folder
Create folder
curl --request POST \
--url https://api.h0p.co/folder \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Marketing Campaign 2024",
"color": "#3B82F6"
}
'import requests
url = "https://api.h0p.co/folder"
payload = {
"name": "Marketing Campaign 2024",
"color": "#3B82F6"
}
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({name: 'Marketing Campaign 2024', color: '#3B82F6'})
};
fetch('https://api.h0p.co/folder', 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/folder",
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([
'name' => 'Marketing Campaign 2024',
'color' => '#3B82F6'
]),
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/folder"
payload := strings.NewReader("{\n \"name\": \"Marketing Campaign 2024\",\n \"color\": \"#3B82F6\"\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/folder")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Marketing Campaign 2024\",\n \"color\": \"#3B82F6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.h0p.co/folder")
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 \"name\": \"Marketing Campaign 2024\",\n \"color\": \"#3B82F6\"\n}"
response = http.request(request)
puts response.read_body{
"id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"organizationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"name": "Marketing Campaign 2024",
"color": "#3B82F6",
"isDefault": false,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-16T14:20:00Z"
}{
"code": "FOLDER_LIMIT_REACHED",
"message": "You have reached the maximum number of folders (50) for your plan. Upgrade to increase your limit."
}{
"code": "ALREADY_EXIST"
}Authorizations
API Key authentication for programmatic access.
How to use:
- Create an API key from your dashboard settings
- Include the key in the
x-api-keyheader 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
Folder name and optional color
Response
Folder successfully retrieved
Complete folder object
Folder UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Organization UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Folder name
Required string length:
1 - 30Example:
"Marketing Campaign 2024"
Folder color (hex)
Pattern:
^#[0-9A-Fa-f]{6}$Example:
"#3B82F6"
Whether this is the default "Links" folder
Example:
false
Creation timestamp
Example:
"2024-01-15T10:30:00Z"
Last update timestamp
Example:
"2024-01-16T14:20:00Z"