Get started

Search businesses

Find bookable businesses

GET/v1/businesses

Query parameters

  • querystring (up to 120 characters)

    What the customer wants, e.g. 'haircut', 'jet ski rental' or a business name.

  • categorystring (up to 60 characters)

    Business type filter, e.g. salon, golf, spa.

  • citystring (up to 80 characters)

    Plain city name, e.g. 'Austin' (no state or country).

  • latnumber (-90–90)

    Latitude of the customer, if known. Send with lng.

  • lngnumber (-180–180)

    Longitude of the customer, if known. Send with lat.

  • radiusKmnumber (0.1–100)

    Search radius in kilometres around lat/lng. Default 15.

  • limitinteger (1–20)

    Maximum businesses to return (1-20, default 5).

Responses

  • 200

    Businesses matching a search, nearest first. When nothing matched, a hint and the coverage say what to try.

    SearchBusinessesResult