Yext Live API icon

Yext Live API

Interact with Yext Live API

Live API → Get Location

AI-generated

Summary

Retrieve details about a specific location from the Yext Live API by providing its account and location IDs.

Inputs

  • Account Id (required) — The unique identifier for the Yext account to query.
  • Location Id (required) — The unique identifier of the location to retrieve.
  • Fields — Optional comma-separated list of specific fields from the Location object to return; supports dot notation for subfields and custom field IDs (e.g., 'custom###').
  • V (required) — Date string in YYYYMMDD format indicating the version of the API to use.

Output shape

A single location object containing the requested fields from the Yext Live API.

Only the specified fields are returned if provided; otherwise, the full location object is returned. The API request may be subject to options like batching, proxy, SSL handling, and timeout as configured in node settings.

Examples

Example 1: Fetch location data with minimal fields

Set 'Account Id', 'Location Id', and 'V' parameters; specify a few relevant fields in 'Fields' (e.g., 'name,address.city'). Returns an object with just those fields.

Discussion