Skip to main content
GET
/
domain
/
all
List all available domains
curl --request GET \
  --url https://api.h0p.co/domain/all \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
    "domain": "links.example.com",
    "isPrimary": true,
    "isVerified": true,
    "createdAt": "2024-01-15T10:30: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

Response

All available domains retrieved successfully

​
id
string<uuid>
required

Domain UUID

Example:

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

​
domain
string
required

Domain name

Example:

"links.example.com"

​
isPrimary
boolean
required

Whether this is the primary domain for the organization

Example:

true

​
isVerified
boolean
required

Whether domain DNS is fully verified and active

Example:

true

​
createdAt
string<date-time> | null
required

Domain creation timestamp

Example:

"2024-01-15T10:30:00Z"