BizKitHub
DocsAPI ReferenceDomain/bff/domain/list
getDomainAdmin BFF

/bff/domain/list

Returns all domains linked to the current organisation with their verification status, HTTP health and DNS information.

DomaingetBffDomainList

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemCountnumberRequired

Total number of domains.

itemsobject[]Required

List of domain items.

Each array item:
idstringRequired

Domain identifier (domain name or fallback ID).

Exampleexample.com
domainVerifiedbooleanRequired

Whether domain ownership has been verified.

environmentstringOptional

Environment label (e.g. production, staging).

Exampleproduction
labelstringOptional

Custom label for the domain.

descriptionstringOptional

Custom description.

domainstringOptional

Fully qualified domain name.

Exampleexample.com
insertedDateDate | string | string | numberOptional

When the domain was first added.

One of 4:
Variant 1
Date

When the domain was first added.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastCheckDateDate | string | string | numberOptional

Last health check timestamp.

One of 4:
Variant 1
Date

Last health check timestamp.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
httpCodenumberOptional

Last HTTP status code.

Example200
httpsSupportbooleanOptional

Whether the domain supports HTTPS.

titlestringOptional

Page title from last crawl.

responseTimenumberOptional

Response time in milliseconds.

uptimeOkbooleanOptional

Whether the domain is considered up.

Response example

application/json
{
  "itemCount": 0,
  "items": [
    {
      "id": "example.com",
      "domainVerified": false,
      "environment": "production",
      "label": "example_label",
      "description": "example_description",
      "domain": "example.com",
      "httpCode": 200,
      "httpsSupport": false,
      "title": "example_title",
      "responseTime": 0,
      "uptimeOk": false
    }
  ]
}

Request example

GET /bff/domain/list

get
curl -X GET "https://api.bizkithub.com/bff/domain/list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key