listDraftPosts( )

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.
Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Blog
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
optionsListDraftPostsOptions

Options for listing multiple draft posts.

Returns
Return Type:Promise<ListDraftPostsResponse>
Was this helpful?
Yes
No