Preview project documentation deletion

Returns active page and folder counts for the node subtree that a confirmed delete will remove.

GET/projects/documentation/{id}/delete-preview

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstring<uuid>required

Project documentation page or folder UUID. This parameter does not accept a project short identifier.

Responses

200

folderCountnumberrequired

pageCountnumberrequired

previewTokenstringrequired

Opaque token for the exact active subtree. Pass it unchanged to the delete operation.

400The documentation node identifier is not a valid UUID.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

404The node does not exist or is not accessible.

errorstring | object

HTTP error name or a structured HTTP exception response.

Show properties

One of:

string

string

object

object

messagestring | string[] | objectrequired

Error message, validation message list, or request-field validation message map.

Show properties

One of:

string

string

string[]

Array of string

string

object

object

statusCodenumberrequired

HTTP status code for this response.

Request

curl -X GET "https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000/delete-preview" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000/delete-preview", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/documentation/550e8400-e29b-41d4-a716-446655440000/delete-preview",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "folderCount": 0,
  "pageCount": 0,
  "previewToken": "string"
}