List hosted domains — Brigg developers

Access & visibility

Allow domains.ListHostedDomains on your API key.

Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

Set up authentication · Choose permissions

Request

No parameters. Send an empty JSON object ({}).

Response

Returns 200 OK with a JSON body.

This operation has no continuation cursor. An empty items array means no matching visible results were returned.

pool_domainsarray of ListHostedDomainsPool_domainsRequired

Outreach domains associated with the workspace.

Item fields

idstringRequired

Unique identifier. Use the value returned by a create or list operation.

domainstringRequired

Website hostname, without a scheme or path.

statusstringRequired

Domain provisioning or registration state.

expires_atnull or numberRequired

Expiry time for the returned temporary action or quote, in Unix milliseconds.

yearly_price_noknumberRequired

Quoted annual price in Norwegian kroner.

renewal_statestringRequired

Current domain renewal state.

has_registrantbooleanRequired

Whether registrant details have been saved.

can_incur_costbooleanRequired

Whether the acting member may perform the billable domain action.

balance_noknumber or nullRequired

Available workspace credit balance in Norwegian kroner.

sitesarray of ListHostedDomainsSitesRequired

Websites available for domain connection.

Item fields

bundle_idstringRequired

Bundle identifier.

labelstringRequired

Human-readable label shown for this item; use its ID or key in API calls.

search_tldsarray of stringRequired

Domain endings supported by this search.

record_typesarray of stringRequired

DNS record types supported by this operation.

ttl_optionsarray of numberRequired

Supported DNS time-to-live values in seconds.

configuredbooleanRequired

Whether the requested domain configuration is present.

itemsarray of Hosted domainRequired

Domains managed for the workspace, with registration and renewal information. This operation has no cursor pagination.

Item fields

idstringRequired

Hosted domain ID used by domain and DNS operations; different from the domain hostname.

domainstringRequired

Website hostname, without a scheme or path.

tldstringRequired

Domain ending, such as no or com.

statusstringRequired

Registration or provisioning state. A registered domain can still need website or DNS configuration.

renewal_statestringRequired

Current state of the domain's renewal process; separate from its registration status.

yearly_price_noknumberRequired

Annual domain price in Norwegian kroner.

nameserversarray of stringRequired

Authoritative nameserver hostnames for the domain.

registered_atnull or numberRequired

Registration time in Unix milliseconds, or null before registration completes.

expires_atnull or numberRequired

Registration expiry in Unix milliseconds, or null when unavailable.

next_renewal_charge_atnull or numberRequired

Next planned renewal charge time in Unix milliseconds, or null if none is scheduled.

site_bundle_idnull or stringRequired

Connected website's content ID, or null if this domain is not assigned to a website.

last_errornull or stringRequired

Most recently recorded provisioning or renewal error, or null when no error is recorded.

created_atnumberRequired

Creation time in Unix milliseconds.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "pool_domains": {
      "type": "array",
      "items": {
        "title": "ListHostedDomainsPool_domains",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier. Use the value returned by a create or list operation."
          },
          "domain": {
            "type": "string",
            "description": "Website hostname, without a scheme or path."
          },
          "status": {
            "type": "string",
            "description": "Domain provisioning or registration state."
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "number"
              }
            ],
            "description": "Expiry time for the returned temporary action or quote, in Unix milliseconds."
          },
          "yearly_price_nok": {
            "type": "number",
            "description": "Quoted annual price in Norwegian kroner."
          },
          "renewal_state": {
            "type": "string",
            "description": "Current domain renewal state."
          }
        },
        "required": [
          "id",
          "domain",
          "status",
          "expires_at",
          "yearly_price_nok",
          "renewal_state"
        ],
        "additionalProperties": false
      },
      "description": "Outreach domains associated with the workspace."
    },
    "has_registrant": {
      "type": "boolean",
      "description": "Whether registrant details have been saved."
    },
    "can_incur_cost": {
      "type": "boolean",
      "description": "Whether the acting member may perform the billable domain action."
    },
    "balance_nok": {
      "type": [
        "number",
        "null"
      ],
      "description": "Available workspace credit balance in Norwegian kroner."
    },
    "sites": {
      "type": "array",
      "items": {
        "title": "ListHostedDomainsSites",
        "type": "object",
        "properties": {
          "bundle_id": {
            "type": "string",
            "description": "Bundle identifier."
          },
          "label": {
            "type": "string",
            "description": "Human-readable label shown for this item; use its ID or key in API calls."
          }
        },
        "required": [
          "bundle_id",
          "label"
        ],
        "additionalProperties": false
      },
      "description": "Websites available for domain connection."
    },
    "search_tlds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Domain endings supported by this search."
    },
    "record_types": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "DNS record types supported by this operation."
    },
    "ttl_options": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Supported DNS time-to-live values in seconds."
    },
    "configured": {
      "type": "boolean",
      "description": "Whether the requested domain configuration is present."
    },
    "items": {
      "type": "array",
      "items": {
        "title": "Hosted domain",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Hosted domain ID used by domain and DNS operations; different from the domain hostname.",
            "examples": [
              "domain_example"
            ]
          },
          "domain": {
            "type": "string",
            "description": "Website hostname, without a scheme or path.",
            "examples": [
              "example.com"
            ]
          },
          "tld": {
            "type": "string",
            "description": "Domain ending, such as no or com.",
            "examples": [
              "com"
            ]
          },
          "status": {
            "type": "string",
            "description": "Registration or provisioning state. A registered domain can still need website or DNS configuration.",
            "examples": [
              "active"
            ]
          },
          "renewal_state": {
            "type": "string",
            "description": "Current state of the domain's renewal process; separate from its registration status.",
            "examples": [
              "ok"
            ]
          },
          "yearly_price_nok": {
            "type": "number",
            "description": "Annual domain price in Norwegian kroner.",
            "examples": [
              199
            ]
          },
          "nameservers": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Authoritative nameserver hostnames for the domain.",
            "examples": [
              [
                "ns1.example.net",
                "ns2.example.net"
              ]
            ]
          },
          "registered_at": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "number"
              }
            ],
            "description": "Registration time in Unix milliseconds, or null before registration completes."
          },
          "expires_at": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "number"
              }
            ],
            "description": "Registration expiry in Unix milliseconds, or null when unavailable."
          },
          "next_renewal_charge_at": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "number"
              }
            ],
            "description": "Next planned renewal charge time in Unix milliseconds, or null if none is scheduled."
          },
          "site_bundle_id": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Connected website's content ID, or null if this domain is not assigned to a website.",
            "examples": [
              null
            ]
          },
          "last_error": {
            "anyOf": [
              {
                "type": "null"
              },
              {
                "type": "string"
              }
            ],
            "description": "Most recently recorded provisioning or renewal error, or null when no error is recorded.",
            "examples": [
              null
            ]
          },
          "created_at": {
            "type": "number",
            "description": "Creation time in Unix milliseconds."
          }
        },
        "required": [
          "id",
          "domain",
          "tld",
          "status",
          "renewal_state",
          "yearly_price_nok",
          "nameservers",
          "registered_at",
          "expires_at",
          "next_renewal_charge_at",
          "site_bundle_id",
          "last_error",
          "created_at"
        ],
        "additionalProperties": false
      },
      "description": "Domains managed for the workspace, with registration and renewal information. This operation has no cursor pagination."
    }
  },
  "required": [
    "items",
    "pool_domains",
    "has_registrant",
    "can_incur_cost",
    "balance_nok",
    "sites",
    "search_tlds",
    "record_types",
    "ttl_options",
    "configured"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "pool_domains": [],
      "has_registrant": false,
      "can_incur_cost": false,
      "balance_nok": null,
      "sites": [],
      "search_tlds": [
        "com",
        "no"
      ],
      "record_types": [
        "A",
        "AAAA",
        "CNAME",
        "TXT"
      ],
      "ttl_options": [],
      "configured": false,
      "items": [
        {
          "id": "domain_example",
          "domain": "example.com",
          "tld": "com",
          "status": "active",
          "renewal_state": "ok",
          "yearly_price_nok": 199,
          "nameservers": [
            "ns1.example.net",
            "ns2.example.net"
          ],
          "registered_at": null,
          "expires_at": null,
          "next_renewal_charge_at": null,
          "site_bundle_id": null,
          "last_error": null,
          "created_at": 1794301200000
        }
      ]
    }
  ]
}

Try the request

Use your API key in a server environment.

Requires BRIGG_ACT_AS: an approved member account ID.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/domains.ListHostedDomains' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.ListHostedDomains", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {}
request = Request(
    "https://api.brigg.app/v1/operations/domains.ListHostedDomains",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "pool_domains": [],
  "has_registrant": false,
  "can_incur_cost": false,
  "balance_nok": null,
  "sites": [],
  "search_tlds": [
    "com",
    "no"
  ],
  "record_types": [
    "A",
    "AAAA",
    "CNAME",
    "TXT"
  ],
  "ttl_options": [],
  "configured": false,
  "items": [
    {
      "id": "domain_example",
      "domain": "example.com",
      "tld": "com",
      "status": "active",
      "renewal_state": "ok",
      "yearly_price_nok": 199,
      "nameservers": [
        "ns1.example.net",
        "ns2.example.net"
      ],
      "registered_at": null,
      "expires_at": null,
      "next_renewal_charge_at": null,
      "site_bundle_id": null,
      "last_error": null,
      "created_at": 1794301200000
    }
  ]
}

Illustrative values, not a live response.