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

Yext Reviews API

The Reviews API from Yext — 14 operation(s) for reviews.

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

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

This API exposes 26 operations across 14 paths, and defines 30 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.

26 operations 14 paths 30 schemas 4 DELETE9 GET1 PATCH7 POST5 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 Reviews 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 26

Across 14 paths, the API surfaces 26 operations — 4 DELETE, 9 GET, 1 PATCH, 7 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Reviews 26
GET
/accounts/{accountId}/reviews
Reviews: List
listReviews 29 params → 200default
POST
/accounts/{accountId}/reviews
Reviews: Create
createReview 3 params body → 201default
GET
/accounts/{accountId}/reviews/{reviewId}
Review: Get
getReview 5 params → 200default
PUT
/accounts/{accountId}/reviews/{reviewId}
Review: Update
updateReview 5 params body → 200default
POST
/accounts/{accountId}/reviews/{reviewId}/comments
Comment: Create
createComment 5 params body → 201202default
POST
/accounts/{accountId}/reviews/{reviewId}/generateComment
Comment: Generate
generateComment 5 params → 200default
PUT
/accounts/{accountId}/reviews/{reviewId}/comments/{commentId}
Comment: Update
updateComment 7 params body → 200202default
DELETE
/accounts/{accountId}/reviews/{reviewId}/comments/{commentId}
Comment: Delete
deleteComment 7 params → 200202default
GET
/accounts/{accountId}/reviewinvites
Review Invitations: List
listReviewInvitations 12 params → 200default
POST
/accounts/{accountId}/reviewinvites
Review Invitations: Create
createReviewInvites 3 params body → 201default
GET
/accounts/{accountId}/reviewinvites/{invitationUid}
Review Invitation: Get
getReviewInvitation 3 params → 200default
PUT
/accounts/{accountId}/reviewinvites/{invitationUid}
Review Invitation: Update
updateReviewInvitation 6 params body → 200default
DELETE
/accounts/{accountId}/reviewinvites/{invitationUid}
Review Invitation: Delete
deleteInvitation 3 params → 200default
PUT
/accounts/{accountId}/reviews/{reviewId}/labels
Review Labels: Update
updateReviewLabels 5 params body → 200default
GET
/accounts/{accountId}/reviews/settings/generation
Review Generation Settings: Get
getReviewGenerationSettings 2 params → 200default
POST
/accounts/{accountId}/reviews/settings/generation
Review Generation Settings: Update
updateReviewGenerationSettings 4 params body → 200default
GET
/accounts/{accountId}/workflowRules
Review Workflow Rules: List
listReviewWorkflowRules 6 params → 200default
POST
/accounts/{accountId}/workflowRules
Review Workflow Rules: Create
createReviewWorkflowRule 3 params body → 200default
GET
/accounts/{accountId}/workflowRules/{workflowRuleId}
Review Workflow Rules: Get
getReviewWorkflowRule 3 params → 200default
PATCH
/accounts/{accountId}/workflowRules/{workflowRuleId}
Review Workflow Rules: Update
updateReviewWorkflowRule 7 params body → 200default
DELETE
/accounts/{accountId}/workflowRules/{workflowRuleId}
Review Workflow Rules: Delete
deleteReviewWorkflowRule 3 params → 200default
GET
/listings/reviews
Review List
getReviewList 3 params → 200400404500
GET
/listings/reviews/{reviewId}
Get Review
getReview 1 param → 200400404500
POST
/listings/reviews/{reviewId}
Create Comment
reviewRespond 1 param body → 200400404500
PUT
/listings/reviews/{reviewId}/comment/{commentId}
Update Comment
updateReviewComment 2 params body → 200400404500
DELETE
/listings/reviews/{reviewId}/comment/{commentId}
Delete Comment
deleteReviewComment 2 params → 200400404500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Review (23 properties), ReviewInvitation (16 properties), ReviewInvitationOptional (16 properties), PartnerReview (12 properties). Each schema is shown below with its type and property counts.

Attestation
object
Attestation certifying SEC compliance requirements for review responses. This is only relevant when the Compliant Review Response setting is enabled for the ac…
4 properties 3 required
UpdatedReviewInvitation
ResponseMetaWithError
UpdateReviewLabelsRequest
object
1 property
PartnerReviewResponseUpdate
object
4 properties
PartnerReviewResponse
object
3 properties
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…
WorkflowRuleInput
object
7 properties
ReviewLabel
object
2 properties
UpdateReview
object
6 properties
WorkflowRule
UpdateReviewInvitationRequest
PartnerReview
object
12 properties 5 required
CreateReview
object
10 properties 3 required
ReviewInvitation
object
16 properties 5 required
CreateWorkflowRule
ReviewGenerationSettings
object
10 properties
ResponseErrorNew
object
2 properties
ReviewInvitationOptional
object
16 properties
PartnerReviewList
object
4 properties 3 required
PartnerReviewComments
array
List of comments on the review
UpdateWorkflowRule
ReviewInvitationDates
object
4 properties
GetReviewInvitation
ResponseMeta
object
1 property
CreateReviewInvitationRequest
ResponseError
object
4 properties
ReviewCommentUpdate
object
2 properties
Review
object
23 properties
ReviewComment
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-reviews-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Analytics API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API API
Yext Domains API
Yext Health Check API
Yext Knowledge Manager API
Yext Licenses API