30 days free. No credit card. Full access from the moment you connect your site.

Start free trial

GeoDirectory List Listings

geodirectory/list-listings searches and filters directory listings: keyword, status, author, categories, tags and sorting.

With Location Manager active it also does proximity search, which is the thing a directory is actually for.

At a glance

Abilitygeodirectory/list-listings
ToolsetGeoDirectory — toolset/geodirectory
GroupGeoDirectory › Listings
RequiresAcrossAI Pro, plus GeoDirectory active on the site
Capabilitymanage_options
SafetyRead-only — changes nothing
RepeatableIdempotent — running it twice leaves the same result
Ships inAcrossAI Pro 0.9.16 and later

How it works

Proximity search takes either near — an address, or the literal me to use the caller’s IP — or a latitude and longitude pair, together with a distance radius. Sorting by distance needs the same.

All of that belongs to the Location Manager add-on. Without it, those parameters are ignored with a warning rather than refused — the search still runs and returns results that are not filtered by location at all.

That is the behaviour to know about, because unfiltered results look like a working search on a site where nothing is nearby.

The distance unit is the site’s configured one rather than a fixed measure, and the default radius is the site search radius rather than unlimited.

Every listing comes back with all of its custom fields, so a search result is usable without a read per row.

Input

NameTypeRequiredWhat it is
post_typestringNoListing type, for example gd_place. Defaults to the site default. See geodirectory/get-directory-overview for the valid values.
searchstringNoFree-text keyword search.
statusstringNo — defaults to publishPost status filter.
authorintegerNoOnly listings owned by this user.
categoriesarrayNoCategory term IDs.
tagsarrayNoTag term IDs.
nearstringLocation Manager onlyAn address to search near, or me to use the caller’s IP.
latitudenumberLocation Manager onlyLatitude. Pair with longitude.
longitudenumberLocation Manager onlyLongitude. Pair with latitude.
distancenumberLocation Manager onlySearch radius in the site’s distance unit. Defaults to the site search radius.
countrystringLocation Manager onlyCountry slug or name.
regionstringLocation Manager onlyRegion slug or name.
citystringLocation Manager onlyCity slug or name.
neighbourhoodstringLocation Manager only, with neighbourhoods enabledNeighbourhood slug or name.
orderbystringNoSort key, for example post_date_desc or overall_rating_desc. distance needs Location Manager plus coordinates.
orderstringNoSort direction.
per_pageintegerNoRows per page.
pageintegerNoPage number.

What comes back

NameTypeWhat it is
listingsarrayEach listing with all of its custom fields.
totalintegerHow many matched.
successbooleanWhether the call completed.
messagestringA one-line summary of what happened, suitable for showing a human.
error_codestringPresent only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation.

Example

Ask your assistant:

Find restaurants within five miles of the station.

It resolves to one call:

{
  "ability": "geodirectory/list-listings",
  "parameters": {
    "near": "Bristol Temple Meads",
    "distance": 5,
    "orderby": "distance"
  }
}

Worth knowing

  • Location parameters are ignored, not refused, without Location Manager.
  • Unfiltered results look like a working search with nothing nearby.
  • The distance unit is the site’s, not miles by default.
  • Custom fields come back on every row.

Related abilities


Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager

Browse the rest: Every ability, by category


Keep reading