List documentation page checkpoints

Returns safe checkpoint metadata in newest-first cursor pages. Historical bodies and internal snapshots are never included. Organization members cannot call this endpoint.

GET/projects/documentation/{pageId}/checkpoints

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

pageIdstring<uuid>required

Documentation page UUID.

Query parameters

cursorstring<uuid>

Checkpoint UUID returned as nextCursor by the prior page.

Responses

200

itemsProjectDocumentationCheckpointSummaryDto[]required

Show properties

Array of ProjectDocumentationCheckpointSummaryDto

actorNamestring | null

actorUserIdstring<uuid>required

changedFieldsstring[]required

createdAtstring<date-time>required

generationnumberrequired

min 1

idstring<uuid>required

reasonstringrequired

Allowed:baselineintervalidlemaximumpre-restore

nextCursorstring<uuid> | null

400

The page UUID or cursor is invalid, or the cursor belongs to another resource.

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.

401

Unauthorized - Invalid or missing authentication token

403

Organization members cannot access documentation history.

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.

404

The page 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.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

pageIdpath*Documentation page UUID.cursorqueryCheckpoint UUID returned as nextCursor by the prior page.

Request

curl -X GET "https://leadtime.app/api/public/projects/documentation/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkpoints" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/documentation/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkpoints", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/documentation/497f6eca-6276-4993-bfeb-53cbbbba6f08/checkpoints",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "items": [
    {
      "actorName": "string",
      "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",
      "changedFields": [
        "title",
        "content"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "generation": 1,
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "reason": "idle"
    }
  ],
  "nextCursor": "53a4a333-2825-45a4-80d2-5f430d088f36"
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}