Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Yext

Yext Listings API

The Listings API from Yext — 26 operation(s) for listings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yext Listings API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Listings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 26 paths, and defines 60 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.yextapis.com/v2.

30 operations 26 paths 60 schemas 3 DELETE14 GET6 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.yextapis.com/v2
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Yext Listings API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

Paths & Operations 30

Across 26 paths, the API surfaces 30 operations — 3 DELETE, 14 GET, 6 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Listings 30
GET
/accounts/{accountId}/listings/publishers
Publishers: List
listPublishers 4 params → 200default
GET
/accounts/{accountId}/listings/accuracy
Listings Accuracy: List
listListingAccuracy 4 params → 200default
GET
/accounts/{accountId}/listings/listings
Listings: List
listListings 9 params → 200default
PUT
/accounts/{accountId}/listings/listings/optin
Listings: Opt In
optInListings 4 params → 200default
PUT
/accounts/{accountId}/listings/listings/optout
Listings: Opt Out
optOutListings 4 params → 200default
PUT
/accounts/{accountId}/listings/listings/confirmsync
Listings: Confirm Sync
confirmSyncListings 5 params → 200default
PUT
/accounts/{accountId}/listings/listings/forcesync
Listings: Force Sync
forceSyncListings 4 params → 200default
GET
/accounts/{accountId}/listings/publishersuggestions
Publisher Suggestions: List
listPublisherSuggestions 7 params → 200default
GET
/accounts/{accountId}/listings/publishersuggestions/{suggestionId}
Publisher Suggestions: Get
getPublisherSuggestion 3 params → 200default
PUT
/accounts/{accountId}/listings/publishersuggestions/{suggestionId}
Publisher Suggestions: Update
updatePublisherSuggestion 4 params → 200default
GET
/accounts/{accountId}/listings/duplicates
Duplicates: List
listDuplicates 7 params → 200default
POST
/accounts/{accountId}/listings/duplicates
Duplicates: Create
createDuplicate 5 params → 201default
DELETE
/accounts/{accountId}/listings/duplicates/{duplicateId}
Duplicates: Delete
deleteDuplicate 3 params → 200default
PUT
/accounts/{accountId}/listings/duplicates/{duplicateId}
Duplicates: Suppress
suppressDuplicate 3 params → 200default
GET
/accounts/{accountId}/listings/verifications/{publisherId}/{locale}/methods
Verification Methods: List
listMethods 8 params → 200default
GET
/accounts/{accountId}/listings/verifications/{publisherId}/statuses
Verification Statuses: List
listStatuses 7 params → 200default
POST
/accounts/{accountId}/listings/verifications/{publisherId}/{locale}/initiate
Verification: Initiate
InitiateVerification 4 params body → 200default
POST
/accounts/{accountId}/listings/verifications/{publisherId}/complete
Verification: Complete
CompleteVerification 3 params body → 200default
GET
/accounts/{accountId}/listings/admins/{publisherId}
Listing Admins: List
listAdmins 7 params → 200default
POST
/accounts/{accountId}/listings/admins/{publisherId}/invite
Listing Admin: Invite
InviteAdmins 3 params body → 200default
GET
/accounts/{accountId}/listings/entitylistings
Entity Listings: List
listEntityListings 9 params → 200default
DELETE
/accounts/{accountId}/listings/delete
Entity Listings: Delete
deleteListings 4 params → 200default
GET
/accounts/{accountId}/questions
Questions: List
listQuestions 7 params → 201default
GET
/accounts/{accountId}/questions/{questionId}
Question: Get
getQuestion 5 params → 201default
GET
/listings/search
Search
Search 14 params → 200400500
GET
/listings/details
Details
Details 1 param → 200400404500
POST
/listings/order
Order
Order body → 200409500
PUT
/listings/{listingId}
Update
Update 1 param body → 200404409500
DELETE
/listings/{listingId}
Cancel
Cancel 1 param → 200400
POST
/listings/suppress
Suppress
Suppress body → 200404409500

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are ListingDelivery (47 properties), Details (31 properties), SearchResult (20 properties), Question (16 properties). Each schema is shown below with its type and property counts.

SuppressionRequest
object
3 properties
DetailsHours
array
The hours associated with the listing.
PickupHours
object
Contains the daily pickup hours, holiday pickup hours, and reopen date for the Entity. Each day is represented by a sub-field of pickupHours. (e.g. monday, tue…
9 properties
GeoData
object
Geolocation data describing where exactly the physical location is
6 properties 2 required
ListingAccuracyField
object
5 properties
Details
object
Base fields for any type of listing
31 properties 10 required
HolidayHour
array
A set of special hours that may vary from the standard business hours.
NextPageToken
string
This field is only included if there is an additional page of data to display. To retrieve the next page of data, pass this field's value as the pageToken para…
ECLID
object
4 properties
DeliveryHours
object
Contains the daily delivery hours, holiday delivery hours, and reopen date for the Entity. Each day is represented by a sub-field of deliveryHours. (e.g. monda…
9 properties
LocationType
string
TakeoutHours
object
Contains the daily takeout hours, holiday takeout hours, and reopen date for the Entity. Each day is represented by a sub-field of takeoutHours. (e.g. monday,…
9 properties
Listing
object
11 properties
Publisher
object
9 properties
ListingAccuracy
object
4 properties
Admin
object
5 properties
ClosedStatus
string
The closed status of the listing
PartnerCategories
array
List of business categories, in your taxonomy, ordered by importance / relevance
BrunchHours
object
Contains the daily brunch hours, holiday brunch hours, and reopen date for the Entity. Each day is represented by a sub-field of brunchHours. (e.g. monday, tue…
9 properties
Question
object
16 properties
ResponseError
object
4 properties
ResponseMetaWithError
EntityType
string
Image
object
You should be able to support and maintain the image size of the photo passed by Yext. We will not send you photos greater than 5MB.
5 properties
Phones
array
A list of the location’s phone numbers. There will be exactly one MAIN phone number and optionally some non-MAIN phone numbers (at most one of each type).
Categories
array
List of business categories, in your taxonomy, ordered by importance / relevance
ListingDelivery
object
47 properties
Hours
object
Contains structured business-hours information. Any days that are unspecified should be interpreted as 'we don't have information for this day'. Days that are…
4 properties
Duplicate
object
12 properties
Video
object
YouTube videos specified by the business
2 properties
Answer
object
8 properties
VerificationCompletion
object
2 properties
OnlineServiceHours
object
Contains the daily online service hours, holiday online service hours, and reopen date for the Entity. Each day is represented by a sub-field of onlineServiceH…
9 properties
HealthcareFacility
object
The following additional fields are available if type is HealthcareFacility.
3 properties 1 required
VerificationStatus
object
3 properties
PublisherSuggestion
object
10 properties
LocationType_2
string
The kind of listing
ListingStatus
string
The status of the listing
URL
object
3 properties
DuplicateUnavailableReason
object
2 properties
FeaturedMessage
object
The featured message of the location
2 properties
AdminInvite
object
2 properties
VerificationMethod
object
5 properties
SearchResult
object
20 properties 12 required
ResponseErrorNew
object
2 properties
SeniorHours
object
Contains the daily senior hours, holiday senior hours, and reopen date for the Entity. Each day is represented by a sub-field of seniorHours. (e.g. monday, tue…
9 properties
Address
object
The structured address for the location
9 properties 6 required
Emails
array
A list of contact email addresses that consumers can use to reach someone who represents the location
EntityListing
object
7 properties
DriveThroughHours
object
Contains the daily drive-through hours, holiday drive-through hours, and reopen date for the Entity. Each day is represented by a sub-field of driveThroughHour…
9 properties
KitchenHours
object
Contains the daily kitchen hours, holiday kitchen hours, and reopen date for the Entity. Each day is represented by a sub-field of kitchenHours. (e.g. monday,…
9 properties
Interval
array
A set of opening and closing times for the specified date.
ListingStatusDetail
object
5 properties
HappyHours
object
Contains the daily happy hours, holiday happy hours, and reopen date for the Entity. Each day is represented by a sub-field of happyHours. (e.g. monday, tuesda…
9 properties
FrequentlyAskedQuestion
object
2 properties
VerificationInitiation
object
4 properties
AccessHours
object
Contains the daily access hours, holiday access hours, and reopen date for the Entity. Each day is represented by a sub-field of accessHours. (e.g. monday, tue…
9 properties
HealthcareProfessional
object
The following additional fields are available if type is HealthcareProfessional.
8 properties 6 required
ResponseMeta
object
1 property
Attribution
object
Listing attribution to whomever the business bought Listings from (i.e., Yext or one of Yext's partners)
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-listings-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
AE Profile APIs.io
Yext Accounts API
AE Profile APIs.io
Yext Administrative API API
AE Profile APIs.io
Yext Analytics API
AE Profile APIs.io
Yext Computations API
AE Profile APIs.io
Yext Configuration API
AE Profile APIs.io
Yext Connectors API
AE Profile APIs.io
Yext Content API API
AE Profile APIs.io
Yext Domains API
AE Profile APIs.io
Yext Health Check API
AE Profile APIs.io
Yext Knowledge Manager API
AE Profile APIs.io
Yext Licenses API
AE Profile APIs.io
#Listings
← Back to Y APIs
API Details
ID
yext:yext-listings-api
Base URL
https://api.yextapis.com/v2
Docs
https://hitchhikers.yext.com/docs/managementapis/
Provider
Yext
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network