List project documentation articles
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 all documentation articles across the workspace or filter by specific project
- Each article includes title, author, and last update timestamp
- Articles 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/documentationAuthorization
AuthorizationOAuth2 access token · headerrequiredScopes:
api:reador
AuthorizationBearer token (JWT) · headerrequiredQuery parameters
pagenumberPage number (1-based)
pageSizenumberNumber of items per page
viewIdstringView identifier for saved grid configurations
quickSearchstringQuick search text. Searches across: title
filtersstringJSON 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.
sortstringJSON 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)
fieldsToReturnany[]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
200Paginated list of project documentation articles
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
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 articles
Unauthorized - Invalid or missing authentication token
Forbidden - Insufficient API scopes or permissions