GET

List Posts


Retrieves a list of up to 100 published posts per request.

List Posts runs with these defaults, which you can override:

  • firstPublishedDate is sorted in descending order, with pinned posts first.
  • paging.limit is 50.
  • paging.offset is 0.
Permissions
Manage Blog
Read Blog
Read Draft Blog Posts
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/blog/v3/posts

Query Params
featuredboolean

Whether to return only featured posts.

Default: false


hashtagsArray <string>

Hashtag filter.

Pass an array of hashtags to return only posts containing any of the provided hashtags. If omitted, all posts with or without hashtags are returned.


categoryIdsArray <string>

Category filter.

Pass an array of category IDs to return only posts with any of the provided categories. If omitted, all posts with or without associated categories are returned.


tagIdsArray <string>

Tag filter.

Pass an array of tag IDs to return only posts with any of the provided tags. If omitted, all posts with or without tags are returned.


sortstring

Sorting options.

Default: FEED


paging.offsetintegerminimum 0

Number of items to skip in the current sort order.

Default: 0


paging.limitintegerminimum 1maximum 100

Number of items to return.

Default:50


paging.cursorstringmaxLength 2000

Pointer to the next or previous page in the list of results.


fieldsToIncludeArray <string>deprecated - use fieldsets instead

Deprecated. Use fieldsets instead. This parameter will be removed on June 30, 2023.

List of post fields to be included in the response.


languagestring

Language filter.

2-or-4-letter language code in IETF BCP 47 language tag format. Pass a language to only receive posts that are in that language. If omitted, posts in all languages are returned.


memberIdstring

Post owner's member ID.


fieldsetsArray <string>

List of additional post fields to include in the response. For example, use the URL fieldset to retrieve the url field in the response in addition to the post’s base fields. Base fields don’t include any of the supported fieldset values. By default only the post’s base fields are returned.

Response Object
postsArray <Post>

List of posts.


metaDataMetaData

Details on the paged set of results returned.

List Posts Example 1
Request
cURL
curl \ 'https://www.wixapis.com/blog/v3/posts?featured=false&categoryIds=a68da372-6bfa-412c-ad29-a3f1000ea3f2&tagIds=edd159e5-603f-4826-a668-8d8cc037ab6d' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "posts": [ { "id": "c9402bb3-2568-4f4d-9d2c-9b0aabf7f6d2", "title": "Best peppers for peppercorn sauce", "excerpt": "Let's talk about choosing best peppers for amazing peppercorn sauce", "firstPublishedDate": "2021-03-18T11:45:14.164Z", "lastPublishedDate": "2021-03-18T11:45:14.164Z", "slug": "best-peppers-for-peppercorn-sauce", "featured": false, "pinned": false, "categoryIds": ["a68da372-6bfa-412c-ad29-a3f1000ea3f2"], "memberId": "2d24cb8a-adcc-466a-ab59-fa74e0889a37", "hashtags": [], "commentingEnabled": true, "minutesToRead": 1, "tagIds": [ "edd159e5-603f-4826-a668-8d8cc037ab6d", "f97a485e-e4ae-4905-86f7-aaa9998672fb", "a337e5fb-d9b6-46af-ab34-d2cf71f7aa2b" ], "pricingPlans": [], "relatedPostIds": [], "pricingPlanIds": [], "language": "en" }, { "id": "230ef0e7-7951-4229-b3fb-fdadc237a5f2", "title": "Popcorn chicken rub", "excerpt": "This is a recipe how to create popcorn rub for chicken.", "firstPublishedDate": "2021-03-18T11:43:29.574Z", "lastPublishedDate": "2021-03-18T11:43:29.574Z", "slug": "popcorn-chicken-rub", "featured": false, "pinned": false, "categoryIds": ["a68da372-6bfa-412c-ad29-a3f1000ea3f2"], "memberId": "2d24cb8a-adcc-466a-ab59-fa74e0889a37", "hashtags": [], "commentingEnabled": true, "minutesToRead": 1, "tagIds": [ "a337e5fb-d9b6-46af-ab34-d2cf71f7aa2b", "edd159e5-603f-4826-a668-8d8cc037ab6d", "f97a485e-e4ae-4905-86f7-aaa9998672fb" ], "pricingPlans": [], "relatedPostIds": [], "pricingPlanIds": [], "language": "en" } ], "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?