NexoDash developer platform

NexoDash API reference

Browse the public HTTP contract, required parameters, and response states from the canonical OpenAPI specification.

Open OpenAPI JSONOpenAPI 3.0.0 · 5 operations
Public contract

Read-only reference generated directly from the runtime specification.

  • Health2
  • Businesses2
  • Reviews1

2 operations

Health

System health and monitoring endpoints

get/api/healthSystem health check

Returns comprehensive system health status including database, Redis, memory, and environment checks

Parameters

This endpoint has no parameters.

Responses

200
System is healthy or degraded
503
System is unhealthy
get/api/monitoringMonitoring metrics

Returns detailed monitoring metrics including cache statistics, performance data, and request logs

Parameters

timeWindowquery
integer — Time window in minutes for metrics aggregation

Responses

200
Monitoring metrics retrieved successfully

2 operations

Businesses

Business directory and information

get/api/public/businessesList all businesses

Returns a paginated list of active businesses with optional filtering and sorting

Parameters

pagequery
integer — Page number (0-based)
limitquery
integer — Items per page
categoryquery
string — Filter by category slug or business type
cityquery
string — Filter by city slug or name
qquery
string — Search businesses by name, description or city

Responses

200
List of businesses retrieved successfully
400
Invalid request parameters
429
Rate limit exceeded
get/api/public/business/{slug}Get business by slug

Returns detailed information about a specific business

Parameters

slugpathRequired
string — Business slug (URL-friendly identifier)

Responses

200
Business details retrieved successfully
404
Business not found

1 operation

Reviews

Customer reviews and ratings

get/api/public/reviewsList reviews

Returns a paginated list of reviews for a specific business

Parameters

businessIdqueryRequired
string · uuid — Business ID to get reviews for
limitquery
integer — Number of reviews to return
pagequery
integer — One-based results page; values beyond the result set use the last page
ratingquery
integer — Exact star rating to include
sortByquery
string — Review ordering

Responses

200
Reviews retrieved successfully
400
Invalid request parameters
404
Tenant or business not found
500
Reviews could not be retrieved
503
Tenant context is temporarily unavailable