Find a business
API operation: Open the endpoint in Scalar
Use GET /business/{business} to retrieve one business by numeric ID or slug. The operation is Business.find.business_business.
The archived path called the final parameter id_or_slug; the current route calls it business. Both occupy the same final segment. The controller treats a numeric value as an ID and another accepted value as a slug.
The ordinary detail flow is public and returns only an enabled business. mode=dashboard requires an authenticated administrator or business manager and can expose a different administrative shape. Query values such as params, type, location, timestamp, and version are operation-specific.
Legacy SDK examples
const response = await ordering.businesses(businessId).parameters(parameters).get()
const dashboardResponse = await ordering.businesses(businessId).asDashboard().get()
Confirm the SDK package and version before using these helpers. For relation expansions, see Business special requests.
OpenAPI reference
Operation: GET /business/{business}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
business | string | Yes | — |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
params | string | No | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields. |
professional_id | integer | No | — |
dropdownoption | integer | No | — |
location | string | No | — |
menu_id | integer | No | — |
mode | string | No | — |
student_id | integer | No | — |
timestamp | integer | No | — |
type | integer | No | — |
user_id | integer | No | — |
version | string | No | — |
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
X-APP-X | string | No | — |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |