Search course sessions near a place
search_nearby_sessionsRead-onlyIdempotent
Upcoming sessions of one course across the venues closest to a postcode or suburb, merged soonest first, with each venue's distance in km. near is required: this server can't tell where the person is, so ask them for their postcode or suburb. If a suburb exists in several states the reply lists the candidates: ask which one and retry with the state or postcode.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| near | Yes | The person's Australian postcode or suburb, optionally with its state, such as 4510 or Caboolture QLD. Required: ask the person for it. | |
| limit | No | How many sessions to return. Larger values are capped at 50; values below 1 use the default. | |
| course | Yes | The course's id, unit code, workshops course id or name, as getCourseDetails accepts. | |
| venues | No | How many of the closest venues to search. Larger values are capped at 5; values below 1 use the default. | |
| date_to | No | The last date to search, YYYY-MM-DD. Defaults to 60 days after date_from and is capped at 365 days after it. | |
| date_from | No | The first date to search, YYYY-MM-DD in Australia/Brisbane time. Defaults to today; a past date means today. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| near | No | The place near resolved to. | |
| sessions | Yes | The sessions, soonest first; null when there are none. | |
| venues_searched | Yes | The venues searched, nearest first. |