Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Social → List Posts

AI-generated

Summary

Retrieve a list of social media posts from a specified Yext account, optionally filtered by various criteria such as post IDs, entity IDs, publishers, text content, or post status, supporting pagination via page tokens.

Inputs

  • Account Id (required) — The identifier for the Yext account from which to list social posts.
  • V (required) — The version date of the API in YYYYMMDD format.
  • Page Token — The token to retrieve the next page of posts when paginating through results.
  • Post Ids — List of specific post IDs to filter the returned posts.
  • Entity Post Ids — List of entity post IDs to filter the returned posts.
  • Entity Ids — List of entity IDs to filter posts related to specified entities.
  • Publishers — List of publishers to restrict posts to those published on these platforms.
  • Text — Filter posts to only those containing the specified text.
  • Status — Filter posts by one or more post statuses such as POST_SCHEDULED, POST_AWAITING_APPROVAL, POST_SUCCEEDED, POST_PROCESSING, DELETE_PROCESSING, POST_FAILED, DELETE_FAILED, or REJECTED_BY_APPROVER.

Output shape

a list of social post records possibly including pagination tokens

Supports pagination via the Page Token input; responses include fields for iterating through pages if more data is available.

Discussion