GET

List Draft Posts


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

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

  • editedDate is sorted in descending order.
  • paging.limit is 50.
  • paging.offset is 0.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Blog
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/blog/v3/draft-posts

Query Params
statusstring

Draft post status filter.

If omitted, draft posts with all statuses are returned. IN_MODERATION is deprecated, use IN_REVIEW instead.


languagestring

Language filter.

2-or-4-letter language code in IETF BCP 47 language tag format. If omitted, draft posts in all languages are returned.


sortstring

Sort options.

Default: EDITING_DATE_DESCENDING


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.


fieldsetsArray <string>

List of additional draft 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 draft post's base fields. Base fields don’t include any of the supported fieldset values. By default only the draft post's base fields are returned.

Response Object
draftPostsArray <DraftPost>

List of draft posts.


metaDataMetaData

Details on the paged set of results returned.

List Draft Posts Example 1
Request
cURL
curl \ 'https://www.wixapis.com/blog/v3/draft-posts' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "draftPosts": [ { "id": "448d1238-0072-4458-a280-bf81c2dd8af1", "title": "Places to visit in Europe", "featured": false, "categoryIds": [], "memberId": "2d24cb8a-adcc-466a-ab59-fa74e0889a37", "hashtags": [], "commentingEnabled": true, "minutesToRead": 0, "tagIds": [], "relatedPostIds": [], "pricingPlanIds": [], "language": "en", "changeOrigin": "AUTO_SAVE", "contentId": "622f285f7952527f485bc138", "editingSessionId": "0aca7f65-1237-482e-bf51-6d14102ee691", "status": "UNPUBLISHED", "mostRecentContributorId": "2d24cb8a-adcc-466a-ab59-fa74e0889a37", "hasUnpublishedChanges": true, "editedDate": "2022-03-14T11:34:55.121Z", "seoData": { "tags": [] }, "seoShowInSearch": true, "seoShowSnippetInSearch": true, "slugs": [], "createdDate": "2022-03-14T11:34:55.121Z" }, { "id": "0bba372c-7f15-4663-84d2-0fa32f1e1226", "title": "Best restaurants in Rome", "featured": false, "categoryIds": [], "memberId": "2d24cb8a-adcc-466a-ab59-fa74e0889a37", "hashtags": [], "commentingEnabled": true, "minutesToRead": 1, "tagIds": [], "relatedPostIds": [], "pricingPlanIds": [], "language": "en", "changeOrigin": "AUTO_SAVE", "contentId": "621cb0dc226b6a33a2877607", "editingSessionId": "56106223-7307-471f-b280-cec482185962", "richContent": { "nodes": [ { "type": "PARAGRAPH", "id": "foo", "nodes": [ { "type": "TEXT", "id": "", "nodes": [], "textData": { "text": "Introduction", "decorations": [] } } ], "paragraphData": { "textStyle": { "textAlignment": "AUTO" }, "indentation": 0 } }, { "type": "PARAGRAPH", "id": "f420g", "nodes": [], "paragraphData": { "textStyle": { "textAlignment": "AUTO" }, "indentation": 0 } }, { "type": "PARAGRAPH", "id": "bcbpt", "nodes": [], "paragraphData": { "textStyle": { "textAlignment": "AUTO" }, "indentation": 0 } } ], "metadata": { "version": 1, "createdTimestamp": "2022-03-14T11:42:11.250Z", "updatedTimestamp": "2022-03-14T11:42:11.250Z", "id": "27c0e783-d64e-4c6b-a6a2-d1f5163509bb" }, "documentStyle": {} }, "status": "UNPUBLISHED", "mostRecentContributorId": "2d24cb8a-adcc-466a-ab59-fa74e0889a37", "hasUnpublishedChanges": true, "editedDate": "2022-02-28T11:24:12.116Z", "content": { "blocks": [ { "key": "foo", "text": "new post", "type": "unstyled", "depth": 0, "inlineStyleRanges": [], "entityRanges": [], "data": {} }, { "key": "f420g", "text": "", "type": "unstyled", "depth": 0, "inlineStyleRanges": [], "entityRanges": [], "data": {} }, { "key": "bcbpt", "text": "", "type": "unstyled", "depth": 0, "inlineStyleRanges": [], "entityRanges": [], "data": {} } ], "entityMap": {}, "documentStyle": {}, "VERSION": "8.69.22", "ID": "27c0e783-d64e-4c6b-a6a2-d1f5163509bb" }, "seoData": { "tags": [] }, "seoShowInSearch": true, "seoShowSnippetInSearch": true, "paidContentParagraph": 1, "slugs": [], "createdDate": "2022-02-28T11:16:01.569Z" } ], "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?