{
  "openapi": "3.1.0",
  "info": {
    "title": "VoiceOne open API",
    "version": "1.0.0",
    "summary": "Read-only information about VoiceOne services for AI agents and developers.",
    "description": "VoiceOne is a Dutch provider of business telephony (Hosted VoIP, SIP trunks, business mobile), web hosting, business e-mail, domain names and OneBooks accounting. This API is read-only and needs no key: prices as shown on voiceone.nl, domain availability, outages and the help center. Ordering happens on the website (order_url). Fair use: 120 requests per 10 minutes per IP, domain checks 30 per 10 minutes. Also available as an MCP server at https://voiceone.nl/mcp.",
    "contact": {
      "name": "VoiceOne support",
      "url": "https://voiceone.nl/contact",
      "email": "support@voiceone.nl"
    },
    "termsOfService": "https://voiceone.nl/algemene-voorwaarden"
  },
  "servers": [
    {
      "url": "https://voiceone.nl/api/agent/v1"
    }
  ],
  "externalDocs": {
    "description": "Uitleg voor ontwikkelaars",
    "url": "https://voiceone.nl/ontwikkelaars"
  },
  "paths": {
    "/services": {
      "get": {
        "operationId": "listServices",
        "summary": "Services and prices as shown on voiceone.nl",
        "parameters": [
          {
            "name": "category",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "mobile",
                "voip",
                "sip-trunk",
                "hosting",
                "email",
                "onebooks"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data",
                    "meta"
                  ],
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Service"
                      }
                    },
                    "meta": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited (see Retry-After)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/domains/extensions": {
      "get": {
        "operationId": "listDomainExtensions",
        "summary": "Domain extensions with yearly prices",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/DomainExtension"
                      }
                    },
                    "meta": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited (see Retry-After)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/domains/check": {
      "get": {
        "operationId": "checkDomain",
        "summary": "Check if a domain name is available",
        "parameters": [
          {
            "name": "domain",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "maxLength": 253
            },
            "description": "example.nl, or just example (then extensions apply)",
            "example": "voorbeeld.nl"
          },
          {
            "name": "extensions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "Comma-separated, max 6, only used when domain has no extension (default nl,com,eu,be)",
            "example": "nl,com"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/DomainCheck"
                      }
                    },
                    "meta": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited (see Retry-After)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/status": {
      "get": {
        "operationId": "getServiceStatus",
        "summary": "Current outages and planned maintenance",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Status"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited (see Retry-After)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/help/search": {
      "get": {
        "operationId": "searchHelpArticles",
        "summary": "Search the help center (Dutch)",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 2,
              "maxLength": 100
            },
            "example": "voicemail"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/HelpArticle"
                      }
                    },
                    "meta": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited (see Retry-After)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    },
    "/health": {
      "get": {
        "operationId": "health",
        "summary": "Health check",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "status"
                  ],
                  "properties": {
                    "status": {
                      "type": "string",
                      "enum": [
                        "ok",
                        "degraded"
                      ]
                    },
                    "version": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Degraded",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "code",
              "message"
            ],
            "properties": {
              "code": {
                "type": "string"
              },
              "message": {
                "type": "string"
              }
            }
          }
        }
      },
      "Price": {
        "type": "object",
        "required": [
          "excl_vat",
          "incl_vat",
          "vat_rate",
          "currency",
          "period"
        ],
        "properties": {
          "excl_vat": {
            "type": "number",
            "description": "Price excluding VAT"
          },
          "incl_vat": {
            "type": "number",
            "description": "Price including VAT"
          },
          "vat_rate": {
            "type": "number",
            "description": "VAT percentage"
          },
          "currency": {
            "type": "string",
            "enum": [
              "EUR"
            ]
          },
          "period": {
            "type": "string",
            "description": "once, month, quarter, year or 'N months'"
          }
        }
      },
      "Service": {
        "type": "object",
        "required": [
          "code",
          "name",
          "category",
          "price",
          "url",
          "order_url"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "mobile",
              "voip",
              "sip-trunk",
              "hosting",
              "email",
              "onebooks"
            ]
          },
          "line": {
            "type": [
              "string",
              "null"
            ],
            "description": "Product line, e.g. Mobiel Compleet or Mobiel Flex"
          },
          "data_bundle": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "features": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "price": {
            "$ref": "#/components/schemas/Price"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "order_url": {
            "type": "string",
            "format": "uri"
          }
        }
      },
      "DomainExtension": {
        "type": "object",
        "required": [
          "extension",
          "registration",
          "renewal"
        ],
        "properties": {
          "extension": {
            "type": "string",
            "example": "nl"
          },
          "registration": {
            "$ref": "#/components/schemas/Price"
          },
          "renewal": {
            "$ref": "#/components/schemas/Price"
          }
        }
      },
      "DomainCheck": {
        "type": "object",
        "required": [
          "domain",
          "available",
          "premium",
          "supported"
        ],
        "properties": {
          "domain": {
            "type": "string"
          },
          "available": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "null = registry gave no answer right now"
          },
          "premium": {
            "type": "boolean"
          },
          "supported": {
            "type": "boolean",
            "description": "VoiceOne registers this extension"
          },
          "price": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/Price"
              },
              {
                "type": "null"
              }
            ]
          },
          "order_url": {
            "type": [
              "string",
              "null"
            ],
            "format": "uri"
          }
        }
      },
      "Status": {
        "type": "object",
        "required": [
          "all_systems_operational",
          "incidents"
        ],
        "properties": {
          "all_systems_operational": {
            "type": "boolean"
          },
          "status_page": {
            "type": "string",
            "format": "uri"
          },
          "incidents": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string"
                },
                "type": {
                  "type": "string",
                  "description": "incident or maintenance"
                },
                "status": {
                  "type": "string"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "affected_services": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "started_at": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "expected_end_at": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "ended_at": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "updated_at": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "updates": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "message": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "HelpArticle": {
        "type": "object",
        "required": [
          "title",
          "url"
        ],
        "properties": {
          "title": {
            "type": "string"
          },
          "summary": {
            "type": [
              "string",
              "null"
            ]
          },
          "category": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "updated_at": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}
