Retrieve website analysis for a business

GET

https://api.middesk.com/v1/businesses/:business_id/website

GET

/v1/businesses/:business_id/website

$ curl https://api.middesk.com/v1/businesses/business_id/website \
>      -H "Authorization: Bearer <token>"

1 {
2   "object": "website",
3   "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4   "url": "https://www.example.com",
5   "created_at": "2026-01-08T20:04:48Z",
6   "updated_at": "2026-01-08T20:05:53Z",
7   "status": "online",
8   "parked": false,
9   "submitted": true,
10   "business_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
11   "business_name_match": true,
12   "phone_numbers": [
13     {
14       "object": "phone_number",
15       "id": "e5f6a7b8-c9d0-1234-efab-567890123456",
16       "number": "number",
17       "contact_type": "contact_type",
18       "recommended": true,
19       "submitted": false,
20       "sources": [
21         {
22           "id": "id",
23           "type": "type",
24           "metadata": {
25             "key": "value"
26           }
27         }
28       ]
29     }
30   ],
31   "addresses": [
32     {
33       "object": "address",
34       "id": "d0e1f2a3-b4c5-6789-defa-012345678901",
35       "address_line1": "123 Main St Ste 100",
36       "city": "San Francisco",
37       "state": "CA",
38       "postal_code": "94105",
39       "full_address": "123 Main St Ste 100, San Francisco, CA 94105",
40       "submitted": true,
41       "sources": [
42         {
43           "id": "id",
44           "type": "type",
45           "metadata": {
46             "key": "value"
47           }
48         }
49       ]
50     }
51   ],
52   "http_status_code": 200,
53   "title": "Example Corp | Business Solutions Platform",
54   "description": "Example Corp provides innovative business solutions for companies of all sizes. The platform offers tools for verification, compliance, and business management.",
55   "domain": {
56     "domain": "EXAMPLE.COM",
57     "domain_id": "1234567890_DOMAIN_COM-VRSN",
58     "creation_date": "2015-03-15T10:30:00Z",
59     "expiration_date": "2030-03-15T10:30:00Z",
60     "registrar": {
61       "name": "Example Registrar LLC"
62     },
63     "redirected": true,
64     "url_shortener": true,
65     "resolved_url": "resolved_url"
66   },
67   "pages": [
68     {
69       "url": "https://www.example.com/",
70       "category": "home",
71       "screenshot_url": "https://static.example.com/screenshots/home.jpg"
72     },
73     {
74       "url": "https://www.example.com/contact",
75       "category": "contact",
76       "screenshot_url": "https://static.example.com/screenshots/contact.jpg"
77     },
78     {
79       "url": "https://www.example.com/about",
80       "category": "about",
81       "screenshot_url": "https://static.example.com/screenshots/about.jpg"
82     }
83   ],
84   "category": "Standard",
85   "posts_summary": "Example Corp is actively engaging on social media, sharing insights on business solutions and industry trends.",
86   "reviews_summary": "The business has received positive reviews highlighting excellent customer service and reliable products.",
87   "names": [
88     {
89       "object": "name",
90       "id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
91       "name": "Example Corp Inc",
92       "submitted": true,
93       "business_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
94       "sources": [
95         {
96           "id": "id",
97           "type": "type",
98           "metadata": {
99             "key": "value"
100           }
101         }
102       ],
103       "type": "legal"
104     },
105     {
106       "object": "name",
107       "id": "d4e5f6a7-b8c9-0123-defa-456789012345",
108       "name": "Example Corp",
109       "submitted": false,
110       "business_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
111       "sources": [
112         {
113           "id": "id",
114           "type": "type",
115           "metadata": {
116             "key": "value"
117           }
118         }
119       ]
120     }
121   ],
122   "people": [
123     {
124       "first_name": "John",
125       "id": "a7b8c9d0-e1f2-3456-abcd-789012345678",
126       "last_name": "Smith",
127       "middle_name": {
128         "key": "value"
129       },
130       "name": "John Smith",
131       "object": "person",
132       "submitted": false,
133       "titles": [
134         {
135           "created_at": "2026-01-08T20:05:48.379Z",
136           "id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
137           "person_id": "a7b8c9d0-e1f2-3456-abcd-789012345678",
138           "title": "CEO",
139           "updated_at": "2026-01-08T20:05:48.379Z"
140         }
141       ]
142     },
143     {
144       "first_name": "Jane",
145       "id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
146       "last_name": "Doe",
147       "middle_name": {
148         "key": "value"
149       },
150       "name": "Jane Doe",
151       "object": "person",
152       "submitted": false,
153       "titles": [
154         {
155           "created_at": "2026-01-08T20:05:48.417Z",
156           "id": "b8c9d0e1-f2a3-4567-bcde-890123456789",
157           "person_id": "c9d0e1f2-a3b4-5678-cdef-901234567890",
158           "title": "CTO",
159           "updated_at": "2026-01-08T20:05:48.417Z"
160         }
161       ]
162     }
163   ],
164   "email_addresses": [
165     {
166       "object": "email_address",
167       "email": "[email protected]",
168       "id": "e1f2a3b4-c5d6-7890-efab-123456789012",
169       "submitted": false,
170       "sources": [
171         {
172           "id": "id",
173           "type": "type",
174           "metadata": {
175             "key": "value"
176           }
177         }
178       ]
179     }
180   ],
181   "rating": {
182     "quality_rating": "high",
183     "indicators": [
184       {
185         "type": "https",
186         "name": "HTTPS",
187         "rating": "positive",
188         "value": "enabled",
189         "description": "Enabled"
190       },
191       {
192         "type": "us_business_presence",
193         "name": "US business presence",
194         "rating": "neutral",
195         "value": "strong",
196         "description": "Strong"
197       },
198       {
199         "type": "third_party_profile_links",
200         "name": "Third party profile links",
201         "rating": "positive",
202         "value": "good",
203         "description": "Good"
204       },
205       {
206         "type": "domain_age",
207         "name": "Domain age",
208         "rating": "positive",
209         "value": "3_to_10_years_old",
210         "description": "3 to 10 years old"
211       },
212       {
213         "type": "spelling_and_grammar",
214         "name": "Spelling and grammar",
215         "rating": "positive",
216         "value": "good",
217         "description": "Good"
218       },
219       {
220         "type": "contact_info",
221         "name": "Contact info",
222         "rating": "positive",
223         "value": "found",
224         "description": "Found"
225       },
226       {
227         "type": "domain_ownership",
228         "name": "Domain ownership",
229         "rating": "positive",
230         "value": "high_confidence",
231         "description": "High confidence"
232       }
233     ]
234   }
235 }

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

idstringformat: "uuid"

urlstring or nullformat: "uri"

The URL that was passed or found for the Business

created_atdatetime

updated_atdatetime

statusenum

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 objects

Phone numbers found on website

addresseslist of objects

Addresses found on website

http_status_codeinteger or nullOptional

HTTP response status code

titlestring or nullOptional

Website page title

descriptionstring or nullOptional

Website meta description

domainobject or nullOptional

Domain registration and redirect information

pageslist of objectsOptional

Website pages with screenshots

errorstring or nullOptional

Error message if website analysis failed

categorystring or nullOptional

Website category classification

platformstring or nullOptional

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

posts_summarystring or nullOptional

Summary of posts found on the website or linked social media profiles

reviews_summarystring or nullOptional

Summary of reviews found on the website or linked third-party profiles

nameslist of objectsOptional

Names found on website

peoplelist of maps from strings to any or nullOptional

People found on website

email_addresseslist of objects or nullOptional

Email addresses found on website

ratingobject or nullOptional

Errors

404

Get Business Website Request Not Found Error