API Reference

Complete endpoint documentation for the Dome Tech Enterprise API.

Base URL

https://api.dometech.com.au/v1

All requests require an X-API-Key header. See Authentication. Both test and live keys use the same URL. The mode field in responses indicates which key type was used.

Response Format

All responses follow a consistent envelope structure with a meta object containing a request ID, timestamp, and mode.

Success Response

{
  "data":  { ... },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-09T12:00:00.000Z",
    "mode":  "live"
  }
}

Error Response

{
  "error":  {
    "code":  "VALIDATION_ERROR",
    "message":  "address is required"
  },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-09T10:00:00.000Z"
  }
}

Paginated Response

{
  "data":  [ ... ],
  "pagination":  {
    "total":  42,
    "limit":  50,
    "offset":  0,
    "has_more":  false
  },
  "meta":  {
    "request_id":  "req_abc123",
    "timestamp":  "2026-02-09T12:00:00.000Z",
    "mode":  "live"
  }
}

Error Codes

All endpoints return errors in a consistent format. See Error Codes for the full list.

Status	Code	Description
400	`VALIDATION_ERROR`	Invalid request body or parameters
400	`INVALID_URL`	Provided URL is not accessible
401	`UNAUTHORIZED`	Missing or invalid API key
403	`FORBIDDEN`	Insufficient permissions
403	`FEATURE_DISABLED`	Endpoint not enabled for your org
403	`INSUFFICIENT_QUOTA`	Usage quota exceeded
404	`JOB_NOT_FOUND`	Job ID does not exist
409	`JOB_IN_PROGRESS`	A job for this resource is already running
429	`RATE_LIMITED`	Too many requests
500	`INTERNAL_ERROR`	Unexpected server error