List project documentation pages

Project documentation allows you to capture, structure, and share project-related knowledge directly in the project context. This helps keep important information like technical notes, repeated questions, and project-specific details organized and accessible.

Retrieves a paginated grid of project documentation with filtering and sorting capabilities. Quick search available on: title. Filterable fields: id, projectId, projectName, title, userId, createdAt, updatedAt, sort. Sortable fields: id, projectId, projectName, title, userId, createdAt, updatedAt, sort.

Features:

View documentation for projects you can access or filter by a specific project
Each page includes title, author, and last update timestamp
Pages can be sorted and filtered using grid parameters

Use cases:

Document project setup procedures and access credentials
Capture technical quirks and troubleshooting steps
Share project-specific notes and guidelines
Keep track of important decisions and context

GET/projects/documentation

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

pagenumber

Page number (1-based)

pageSizenumber

Number of items per page

viewIdstring

View identifier for saved grid configurations

quickSearchstring

Quick search text. Searches across: title

filtersstring

JSON string containing filter configuration.

Available Fields:

id (string): Documentation ID
projectId (set): Project ID
projectName (string): Project name
title (string): Documentation title
userId (string): Author user ID
createdAt (date): Creation timestamp
updatedAt (date): Last update timestamp
sort (number): Sort order

Filter Structure:

[
  {
    "type": "string|number|date|set|boolean|array|task_status|task_type",
    "fieldName": "field_name",
    "value": {
      "comparison": "comparison_type",
      "value": "filter_value"
    }
  }
]

Group Filters (AND/OR Combinations):

[
  {
    "type": "group",
    "fieldName": "group0.18807479823070028",
    "value": {
      "type": "or",
      "filters": [
        {
          "type": "string",
          "fieldName": "fileName",
          "value": {
            "comparison": "contain",
            "value": "aa"
          }
        },
        {
          "type": "number",
          "fieldName": "rowCount",
          "value": {
            "comparison": ">=",
            "value": 33
          }
        }
      ]
    }
  }
]

Available Comparison Operators:

id (string): Documentation ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
projectId (set): Project ID (set filter). Available comparisons: in, not_in, is_empty, is_not_empty
projectName (string): Project name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
title (string): Documentation title (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
userId (string): Author user ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty
createdAt (date): Creation timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
updatedAt (date): Last update timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty
sort (number): Sort order (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty

Note: Use quickSearch parameter for simple text search instead of adding it to filters.

sortstring

JSON array of sort objects.

Sortable Fields:

id: Documentation ID
projectId: Project ID
projectName: Project name
title: Documentation title
userId: Author user ID
createdAt: Creation timestamp
updatedAt: Last update timestamp
sort: Sort order

Sort Structure:

[
  {
    "field": "field_name",
    "direction": "asc|desc"
  }
]

Default Sort: sort (asc)

fieldsToReturnstring[]

Comma-separated list of field names to include in response items. If not provided, all fields are returned.

Available Fields: id, projectId, projectName, title, userId, createdAt, updatedAt, sort

Responses

200

Paginated list of project documentation pages

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

pagequeryPage number (1-based)pageSizequeryNumber of items per pageviewIdqueryView identifier for saved grid configurationsquickSearchqueryQuick search text. Searches across: titlefiltersqueryJSON string containing filter configuration. **Available Fields:** - **id** (string): Documentation ID - **projectId** (set): Project ID - **projectName** (string): Project name - **title** (string): Documentation title - **userId** (string): Author user ID - **createdAt** (date): Creation timestamp - **updatedAt** (date): Last update timestamp - **sort** (number): Sort order **Filter Structure:** ```json [ { "type": "string|number|date|set|boolean|array|task_status|task_type", "fieldName": "field_name", "value": { "comparison": "comparison_type", "value": "filter_value" } } ] ``` **Group Filters (AND/OR Combinations):** ```json [ { "type": "group", "fieldName": "group0.18807479823070028", "value": { "type": "or", "filters": [ { "type": "string", "fieldName": "fileName", "value": { "comparison": "contain", "value": "aa" } }, { "type": "number", "fieldName": "rowCount", "value": { "comparison": ">=", "value": 33 } } ] } } ] ``` **Available Comparison Operators:** - **id** (string): Documentation ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **projectId** (set): Project ID (set filter). Available comparisons: in, not_in, is_empty, is_not_empty - **projectName** (string): Project name (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **title** (string): Documentation title (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **userId** (string): Author user ID (string filter). Available comparisons: contain, not_contain, equal, starts_with, ends_with, is_empty, is_not_empty - **createdAt** (date): Creation timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty - **updatedAt** (date): Last update timestamp (date filter). Available comparisons: equal, not_equal, >, <, >=, <=, between, lastMonth, thisMonth, is_empty, is_not_empty - **sort** (number): Sort order (number filter). Available comparisons: equal, not_equal, >, <, >=, <=, is_empty, is_not_empty **Note:** Use `quickSearch` parameter for simple text search instead of adding it to filters.sortqueryJSON array of sort objects. **Sortable Fields:** - **id**: Documentation ID - **projectId**: Project ID - **projectName**: Project name - **title**: Documentation title - **userId**: Author user ID - **createdAt**: Creation timestamp - **updatedAt**: Last update timestamp - **sort**: Sort order **Sort Structure:** ```json [ { "field": "field_name", "direction": "asc|desc" } ] ``` **Default Sort:** sort (asc)fieldsToReturnqueryComma-separated list of field names to include in response items. If not provided, all fields are returned. **Available Fields:** id, projectId, projectName, title, userId, createdAt, updatedAt, sort

Request

curl -X GET "https://leadtime.app/api/public/projects/documentation" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/documentation", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/documentation",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

Paginated list of project documentation pages