Get your pending publication schedule for a post
GET /posts/{id}/publication-schedule
Returns the publication schedule you set for one of your posts while
it’s still marked as waiting. When there’s none, schedule is
null. Only the post’s author can read it.
You need to be signed in. A post you can’t read, including a deleted
one, is 404, and a readable post someone else wrote is 403. Reading
doesn’t need the posts.publish capability, and the post doesn’t
have to be a draft.
Only a schedule still marked as waiting is shown. Once it’s marked
as done, failed or cancelled, schedule is null, and this route
doesn’t say which. Being marked as waiting doesn’t prove the post is
unpublished: a schedule whose time has passed is shown until the
background job has finished with it, and if the job published the
post but couldn’t record that, the schedule stays marked as waiting.
Other scheduled actions on the same post aren’t included, and a
system.admin holder can also cancel yours through the
scheduled-actions routes.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The post’s id.
Responses
Section titled “ Responses ”Your pending schedule for the post, or null in schedule when there’s none.
object
object
The schedule’s id. A replacement gets a new id.
The post this schedule publishes.
When the post becomes due to publish. A background job normally checks for due schedules about every five minutes, so the post is published some time after this, if the publish checks pass then; there’s no deadline.
pending while the schedule is marked as waiting, which doesn’t by itself mean the post is still unpublished; the cancel route returns cancelled. These routes never return done or failed: a schedule marked as finished is no longer shown here.
The author who scheduled it; always the requesting user.
When the schedule was saved.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completedResource not found
object
Human-readable error summary
Example
the request could not be completedUnexpected server error
object
Human-readable error summary
Example
the request could not be completed