listPosts( )


Retrieves a list of published posts.

The listPosts() function returns a Promise that resolves to a list of up to 100 published posts.

Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.

By default, the list is sorted by firstPublishedDate in descending order, and the amount of posts returned is 50.

Permissions
Read Blog
Manage Blog
Read Draft Blog Posts
Learn more about app permissions.
Method Declaration
Copy
function listPosts(options: ListPostsOptions): Promise<ListPostsResponse>;
Method Parameters
optionsListPostsOptions

Sort, filter, and paging options.

Returns
Return Type:Promise<ListPostsResponse>
JavaScript
import { posts } from "wix-blog-backend"; export async function listPostsFunction() { try { const result = await posts.listPosts(); const firstPostTitle = result.posts[0].title; const firstPostExcerpt = result.posts[0].excerpt; console.log("Retrieved Result:", result); return result; } catch (error) { console.error(error); } } /* Promise resolves to: * { * "posts": [ * { * "_id": "0a265609-e16e-4c96-b71a-2a62b513e6c8", * "categoryIds": [], * "commentingEnabled": true, * "excerpt": "some text", * "featured": false, * "firstPublishedDate": "2022-05-25T13:56:19.023Z", * "hashtags": [], * "heroImage": "" * "language": "en", * "lastPublishedDate": "2022-05-25T13:56:19.023Z", * "media": { * "wixMedia": { * "image": "wix:image://v1/75059a_9f8cd2f1282c4dc7ae9a4bea155e2661~mv2.jpg#originWidth=602&originHeight=773" * }, * "displayed": true, * "custom": false * }, * "memberId": "4b9f4b64-0792-481e-9289-b2550c1bb7ea", * "minutesToRead": 1, * "pinned": false, * "preview": false, * "pricingPlanIds": [], * "relatedPostIds": [], * "slug": "_new-post", * "tagIds": [], * "title": "new post", * "translationId": "" * }, * { * "_id": "ccbb6257-ed0e-4521-97df-8b5b207adb00", * "categoryIds": [ * "1ea22fce-bc3c-4b78-9422-f0f367f8628e" * ], * "commentingEnabled": true, * "excerpt": "Create a blog post subtitle that summarizes your post in a few short, punchy sentences and entices your audience to continue reading....", * "featured": true, * "firstPublishedDate": "2020-08-05T21:00:00.000Z", * "hashtags": [ * "sea", * "sun" * ], * "heroImage": "" * "language": "en", * "lastPublishedDate": "2020-08-05T21:00:00.000Z", * "media": { * "wixMedia": { * "image": "wix:image://v1/75059a_9f8cd2f1282c4dc7ae9a4bea155e2661~mv2.jpg#originWidth=602&originHeight=773" * }, * "displayed": true, * "custom": false * }, * "memberId": "4b9f4b64-0792-481e-9289-b2550c1bb7ea", * "minutesToRead": 1, * "moderationDetails": {}, * "pinned": false, * "pricingPlanIds": [ * "b6e94a0c-4d0f-435e-9602-0dd61d2aca37" * ], * "relatedPostIds": [ * "425a5dca-c32d-40e6-b2d7-a8ffa3addded" * ], * "slug": "my-vacation", * "tagIds": [ * "b698f939-cab5-419b-9966-ba0fa3316de9" * ], * "title": "My vacation", * "translationId": "3cd710b7-c28d-4547-9b8a-3c1ec776064b" * } * ], * "metaData": { * "count": 2, * "offset": 0, * "total": 2 * } * } */
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?