Document Service API: Usage with Draft & Publish

Page summary:

Use the status parameter with the Document Service API to retrieve published or draft versions of documents, count documents by status, and directly publish documents during creation or updates.

By default the Document Service API returns the draft version of a document when the Draft & Publish feature is enabled. This page describes how to use the status parameter to:

• return the published version of a document,
• count documents depending on their status,
• and directly publish a document while creating it or updating it.

Note

Passing { status: 'draft' } to a Document Service API query returns the same results as not passing any status parameter.

For derived publication cohorts (never-published, modified, and others), see Document Service API: publicationFilter.

Get the published version with findOne()

strapi.documents().findOne()

Return the published version of a specific document.

GETstrapi.documents().findOne()

await strapi.documents('api::restaurant.restaurant').findOne({
documentId: 'a1b2c3d4e5f6g7h8i9j0klm',
status: 'published'
});

Returns

{
documentId: "a1b2c3d4e5f6g7h8i9j0klm",
name: "Biscotte Restaurant",
publishedAt: "2024-03-14T15:40:45.330Z",
locale: "en", // default locale
// …
}

Get the published version with findFirst()

strapi.documents().findFirst()

Return the published version of the first matching document.

GETstrapi.documents().findFirst()

const document = await strapi.documents("api::restaurant.restaurant").findFirst({
status: 'published',
});

Returns

{
documentId: "a1b2c3d4e5f6g7h8i9j0klm",
name: "Biscotte Restaurant",
publishedAt: "2024-03-14T15:40:45.330Z",
locale: "en", // default locale
// …
}

Get the published version with findMany()

strapi.documents().findMany()

Return the published versions of all matching documents.

GETstrapi.documents().findMany()

const documents = await strapi.documents("api::restaurant.restaurant").findMany({
status: 'published'
});

Returns

[
{
  documentId: "a1b2c3d4e5f6g7h8i9j0klm",
  name: "Biscotte Restaurant",
  publishedAt: "2024-03-14T15:40:45.330Z",
  locale: "en", // default locale
  // …
}
// …
]

count() only draft or published versions

To take into account only draft or published versions of documents while counting documents with the Document Service API, pass the corresponding status parameter:

// Count draft documents (also actually includes published documents)
const draftsCount = await strapi.documents("api::restaurant.restaurant").count({
  status: 'draft'
});

// Count only published documents
const publishedCount = await strapi.documents("api::restaurant.restaurant").count({
  status: 'published'
});

Note

Since published documents necessarily also have a draft counterpart, a published document is still counted as having a draft version.

This means that counting with the status: 'draft' parameter still returns the total number of documents matching other parameters, even if some documents have already been published and are not displayed as "draft" or "modified" in the Content Manager anymore. To count only never-published drafts, pass a publicationFilter value such as 'never-published' or 'never-published-document'.

Create a draft and publish it

strapi.documents().create()

Create a new document and immediately publish it.

GETstrapi.documents().create()

await strapi.documents('api::restaurant.restaurant').create({
data: {
  name: "New Restaurant",
},
status: 'published',
})

Returns

{
documentId: "d41r46wac4xix5vpba7561at",
name: "New Restaurant",
publishedAt: "2024-03-14T17:29:03.399Z",
locale: "en" // default locale
// …
}

Update a draft and publish it

strapi.documents().update()

Update an existing document and immediately publish it.

GETstrapi.documents().update()

await strapi.documents('api::restaurant.restaurant').update({
documentId: 'a1b2c3d4e5f6g7h8i9j0klm',
data: {
  name: "Biscotte Restaurant (closed)",
},
status: 'published',
})

Returns

{
documentId: "a1b2c3d4e5f6g7h8i9j0klm",
name: "Biscotte Restaurant (closed)",
publishedAt: "2024-03-14T17:29:03.399Z",
locale: "en" // default locale
// …
}