GET
Business search
/api/directorySearch published businesses by name, service or location. Use the returned slug to read a profile.
PUBLIC BUSINESS DATA · DEVELOPER CENTERBusiness discovery.
Business discovery.
Ready to build on.
Find a business, read its public profile, and connect your application to a shared business identity.
Public GET accessNo API key for these readsJSON responses
YOUR FIRST REQUEST
Start with three businesses.
Run a small search, choose a returned slug, then request its business profile.
curl --fail-with-body \
'https://directory.websdocs.com/api/directory?limit=3&page=1' \
-H 'Accept: application/json'- 01Search published records
- 02Read
/business/{slug}.json - 03Follow the returned discovery links
CHOOSE THE RIGHT DATA
A clear starting point for every request.
Start with these public read endpoints. The deployed OpenAPI document is the reference for the running API.
GET
Business profile
/business/{slug}.jsonRead one published business identity. Replace {slug} with a slug returned by Directory search.
GET
Homepage counts
/api/homepageRead published, registry-verified and country counts from the scheduled Metrics snapshot.
GET
Category catalogue
/api/categoriesRead approved category slugs. Continue using nextCursor as the next request’s after value.
GET
Discovery manifest
/.well-known/asg-directory.jsonFind machine-readable Directory entry points and discovery links.
GET
Globe data
/api/globeRead the globe payload when building a map. It can be larger than a summary; use /api/homepage for counts.
Migrating an older integration? /api/locations and /api/activity are retired. Filter business search by country.
EXPLORE BEFORE YOU INTEGRATE
Make a request. See the real response.
No requests run automatically. This playground allows selected public GET routes only.
Ready when you are.
Choose a request path to generate an example.Browser integrations depend on the API’s CORS policy. If access is blocked, test from your server.
Response
Not requestedJSON appears here after you run a request.
No request yet. Start with a small result set. You can inspect the response here without leaving the page.
Manual requests · 20-second timeout · 1 MiB display limit · no background refresh
BUILD WITH CONFIDENCE
The details that make an integration reliable.
Keep queries small, respect freshness, and distinguish published evidence from ownership or agent availability.
Search & pagination
Business search accepts q, country, city, category, page and limit. Start at page 1.
Follow pagination.hasNext. Do not assume a total is exact unless pagination.totalExact confirms it. Page-size limits are set by the server.
Categories use a cursor: pass returned nextCursor as after. Use category slugs from the API.
Snapshots & missing values
/api/homepage returns the three homepage counts.
Check generatedAt and available delivery fields. Keep null as unknown; do not turn it into zero. Respect cache headers and avoid rapid polling.
Errors & retries
Check the HTTP status before reading a success payload. Handle missing profiles, unavailable snapshots and upstream failures.
If you receive HTTP 429, honor Retry-After when supplied. For transient failures, use capped backoff with jitter. Do not repeatedly retry invalid requests.
This page does not promise a fixed rate limit or uptime SLA. Inspect current responses and contact support for sustained integration needs.
Identity & AI discovery
Registry verification, owner claims and operational agents are different signals. Treat each field according to its contract.
Read a business profile first. Follow returned gatewayDiscovery.urls; do not guess a gateway identifier from a Directory slug.
confirmed_live reflects a previous check, not guaranteed availability. Supported interactions may require separate authorization or credits. Explore the AI network ↗
Which operations belong outside this playground?
Listing submission, claims, corrections and Website Audit use separate workflows. They can create records or trigger processing, so this playground does not run them. See List Business, Claim Business, Corrections and Website Audit. Public reads do not grant permission to manage a business.
KEEP THE CONTRACT CLOSE
Everything you need to go deeper.
Use the specification for the full API surface and discovery documents for published entry points.