Skip to main content

List businesses

API operation: Open the endpoint in Scalar

Use GET /business to list businesses. The operation is Business.findAll.business.

The operation supports public discovery and can use type, location, dropdownoption, params, offset, limit, timestamp, and other operation-specific query values. Not every parameter combination is valid; support can depend on project configuration.

mode=dashboard is authenticated. In the list controller it accepts administrators, business managers, and driver managers, then applies role-specific visibility. The ordinary discovery flow can filter businesses by delivery context without dashboard mode.

GET https://api.ordering.co/v400/en/YOUR_PROJECT/business?type=1&location=40.7539143,-73.9810162&params=zones,name,slug

The archived guide described only delivery, pickup, and eat-in. The operation supports additional order types; the supported order types can depend on project configuration.

For fields and expansions, see Business model and Business special requests.

OpenAPI reference​

Operation: GET /business

Query parameters

NameTypeRequiredDescription
paramsstringNoComma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.
orderBystringNoField to sort by, with - prefixed for descending order. Multiple fields can be chained with commas.
wherestringNoJSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its x-ordering-whereable schema extension.
pageintegerNoPage number, starting at 1. Applies only to lists that return a pagination block.
page_sizeintegerNoNumber of items per page.
dropdownoptionintegerNo—
dropdown_option_idintegerNo—
citystringNo—
disabled_businessbooleanNo—
limitintegerNo—
locationstringNoLocation filter serialized as lat,lng. The legacy flow also accepts a JSON-encoded object with lat and lng.
menu_idintegerNo—
modestringNo—
offsetintegerNo—
order_type_idintegerNo—
timestampintegerNo—
typeintegerNo—
vstringNo—

Header parameters

NameTypeRequiredDescription
X-APP-XstringNo—

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference