Retrieve website analysis for a business

curl https://api.middesk.com/v1/businesses/business_id/website \
     -u "<username>:<password>"

{
  "object": "website",
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "url": "https://www.example.com",
  "created_at": "2026-01-08T20:04:48Z",
  "updated_at": "2026-01-08T20:05:53Z",
  "status": "online",
  "parked": false,
  "submitted": true,
  "business_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "business_name_match": true,
  "phone_numbers": [
    "phone_numbers"
  ],
  "addresses": [
    "addresses"
  ],
  "http_status_code": 200,
  "title": "Example Corp | Business Solutions Platform",
  "description": "Example Corp provides innovative business solutions for companies of all sizes. The platform offers tools for verification, compliance, and business management.",
  "domain": {
    "domain": "EXAMPLE.COM",
    "domain_id": "1234567890_DOMAIN_COM-VRSN",
    "creation_date": "2015-03-15T10:30:00Z",
    "expiration_date": "2030-03-15T10:30:00Z",
    "registrar": {
      "name": "Example Registrar LLC"
    }
  },
  "pages": [
    {
      "url": "https://www.example.com/",
      "category": "home",
      "screenshot_url": "https://static.example.com/screenshots/home.jpg"
    },
    {
      "url": "https://www.example.com/contact",
      "category": "contact",
      "screenshot_url": "https://static.example.com/screenshots/contact.jpg"
    },
    {
      "url": "https://www.example.com/about",
      "category": "about",
      "screenshot_url": "https://static.example.com/screenshots/about.jpg"
    }
  ],
  "category": "Standard",
  "people": [
    {
      "object": "person",
      "first_name": "John",
      "middle_name": {
        "key": "value"
      },
      "last_name": "Smith",
      "name": "John Smith",
      "titles": [
        {
          "id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
          "person_id": "a7b8c9d0-e1f2-3456-abcd-789012345678",
          "title": "CEO",
          "created_at": "2026-01-08T20:05:48.379Z",
          "updated_at": "2026-01-08T20:05:48.379Z"
        }
      ],
      "id": "a7b8c9d0-e1f2-3456-abcd-789012345678",
      "submitted": false
    },
    {
      "object": "person",
      "first_name": "Jane",
      "middle_name": {
        "key": "value"
      },
      "last_name": "Doe",
      "name": "Jane Doe",
      "titles": [
        {
          "id": "b8c9d0e1-f2a3-4567-bcde-890123456789",
          "person_id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
          "title": "CTO",
          "created_at": "2026-01-08T20:05:48.417Z",
          "updated_at": "2026-01-08T20:05:48.417Z"
        }
      ],
      "id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
      "submitted": false
    }
  ],
  "email_addresses": [
    "email_addresses"
  ]
}

Returns website analysis data including domain info, pages, and quality indicators

Authentication

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

Path parameters

business_idstringRequired

Business ID

Query parameters

includestringOptional

Include additional data. Use “indicator_details” to include source examples and explanations for each indicator

Response

website analysis found

objectenum

Allowed values:

idstringformat: "uuid"

urlstringformat: "uri"

created_atdatetime

updated_atdatetime

statusenum

Allowed values:

parkedboolean or null

Whether the domain is parked

submittedboolean

Whether the website was submitted by user

business_idstringformat: "uuid"

business_name_matchboolean

Whether website content matches business name

phone_numberslist of strings

Phone numbers found on website

addresseslist of strings

Addresses found on website

http_status_codeinteger or null

HTTP response status code

titlestring or null

Website page title

descriptionstring or null

Website meta description

domainobject or null

Domain registration information

pageslist of objects or null

Website pages with screenshots

errorstring or null

Error message if website analysis failed

categorystring or null

Website category classification

platformstring or null

Website platform (e.g., instagram.com, facebook.com)

peoplelist of maps from strings to any or null

People found on website

email_addresseslist of strings or null

Email addresses found on website

Authentication

Path parameters

Query parameters

Response

Errors