Skip to main content
GET
/
folder
/
list
List folders with pagination
curl --request GET \
  --url https://api.h0p.co/folder/list \
  --header 'x-api-key: <api-key>'
{
  "count": 42,
  "data": [
    {
      "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"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API Key authentication for programmatic access.

How to use:

  1. Create an API key from your dashboard settings
  2. Include the key in the x-api-key header with each request
  3. 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

Query Parameters

​
limit
number | null
default:25

Maximum number of items to return per page

Required range: 0 <= x <= 50
Example:

25

​
page
number | null
default:0

Page number for pagination (zero-indexed)

Required range: x >= 0
Example:

0

​
search
string

Search query string to filter results

Example:

"example"

Response

Paginated list of folders

​
count
number
required

Total number of items matching the query

Required range: x >= 0
Example:

42

​
data
object[]
required