Actions24
- Live API Actions
- List Entities
- Get Entity
- Geo Search Entities
- Get Entity Schema
- Get Language Profile
- List Language Profiles
- List All Language Profiles
- Get Menus
- Get Bios
- Get Products
- Get Events
- Get Language Profiles
- List Location Language Profiles
- Get Language Profiles Schema
- Get Location
- Locations List
- Get Location Schema
- Geo Search
- Create Question
- Create Review
- Update Review
- Delete Review
- Content API Actions
Live API → Geo Search Entities
AI-generatedSummary
Search for entities near a specified geographic location within a specified radius using the Yext Live API, applying optional filters and parameters to refine results.
Inputs
- Account Id (required) — The Yext account identifier under which the geosearch will be performed.
- Location (required) — The geographic center point for the search; can be specified as latitude and longitude coordinates or as a free-form address that is geocoded.
- V (required) — The version date of the API to use, formatted as YYYYMMDD.
- Country Bias — Two-character ISO 3166-1 country code to bias the geocoder towards a specific country.
- Entity Types — Comma-separated list of entity types to filter the search (e.g., 'location,event'). Supports standard and custom entity types.
- Fields — Comma-separated list of field names to return for each entity, supporting dot notation for nested fields.
- Filter — URL-encoded JSON string representing complex filtering conditions to be applied to the resulting entities.
- Geocoder Bias — Latitude, longitude, and approximate radius in miles to bias the geocoder results.
- Languages — Comma-separated list of language codes to filter entities by profile language. Use 'primary' to select the primary profile.
- Limit — Maximum number of results to return (default is 10).
- Offset — Number of results to skip for pagination; cannot be used with pageToken and limited to a maximum of 9950.
- Radius — Search radius in miles around the specified location (default is 10 miles).
- Randomization — A value between 0 and 1 to randomize the sort order of results; 0 means no randomness, 1 means fully random within the radius.
- Randomization Token — Token to use with offset for iterating through randomized search results under consistent randomness.
- Saved Filter Ids — Comma-separated list of saved filter IDs; results will match entities included in all specified saved filters.
Output shape
a JSON object containing a list of entities matching the geospatial and filtering criteria defined in the request parameters
Results can be paginated using limit and offset parameters. Filtering supports complex JSON-based filters. Randomization parameters affect result ordering. Entities returned include only requested fields if specified.