Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.grantex.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

GET /v1/domains

​
Authentication

Requires a developer API key in the Authorization header.

​
Request Headers

HeaderValue
AuthorizationBearer <api_key>

​
Example Request

curl https://grantex-auth-dd4mtrt2gq-uc.a.run.app/v1/domains \
  -H "Authorization: Bearer gx_..."

​
Response — 200 OK

{
  "domains": [
    {
      "id": "dom_01HXYZ...",
      "domain": "auth.example.com",
      "verified": true,
      "verifiedAt": "2026-04-05T15:00:00.000Z",
      "createdAt": "2026-04-05T12:00:00.000Z"
    },
    {
      "id": "dom_02ABCD...",
      "domain": "agents.example.com",
      "verified": false,
      "verifiedAt": null,
      "createdAt": "2026-04-05T13:00:00.000Z"
    }
  ]
}

​
Response Fields

FieldTypeDescription
domainsarrayArray of domain objects
domains[].idstringUnique domain ID
domains[].domainstringThe domain name
domains[].verifiedbooleanWhether DNS verification has passed
domains[].verifiedAtstring | nullISO-8601 timestamp of verification, or null
domains[].createdAtstringISO-8601 creation timestamp

​
Error Responses

StatusCodeDescription
401UNAUTHORIZEDInvalid or missing API key

​
SDK Examples

import Grantex from '@grantex/sdk';

const grantex = new Grantex({ apiKey: 'gx_...' });

const { domains } = await grantex.domains.list();
for (const d of domains) {
  console.log(`${d.domain} — verified: ${d.verified}`);
}