Wiki

Create, update, search, and manage wiki pages. Build a project knowledge base.

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

The wiki provides a structured knowledge base within each project. Pages support markdown content, nested hierarchies, and full-text search.

List Wiki Pages

Returns wiki pages for a project.

GET /wiki/pages?company_slug={slug}&project_slug={slug}

Query Parameters

Parameter	Type	Required	Description
`company_slug`	string	Yes	Workspace identifier
`project_slug`	string	Yes	Project identifier

Example Request

curl -X GET "https://services.gitscrum.com/wiki/pages?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Example Response

{
  "data": [
    {
      "uuid": "d4e5f6a7-b8c9-0123-def0-123456789abc",
      "title": "API Architecture",
      "content": "# API Architecture\n\nOur REST API follows...",
      "parent_uuid": null,
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "revisions_count": 3,
      "created_at": "2026-01-20T10:00:00Z",
      "updated_at": "2026-02-01T14:30:00Z"
    }
  ]
}

Get Wiki Page

Returns a single wiki page with full content.

GET /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}

Path Parameters

Parameter	Type	Description
`uuid`	string	Wiki page UUID

Create Wiki Page

Creates a new wiki page.

POST /wiki/pages

Request Body

Field	Type	Required	Description
`title`	string	Yes	Page title
`content`	string	Yes	Page content (markdown)
`company_slug`	string	Yes	Workspace identifier
`project_slug`	string	Yes	Project identifier
`parent_uuid`	string	No	Parent page UUID (for nested pages)

Example Request

curl -X POST "https://services.gitscrum.com/wiki/pages" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Deployment Guide",
    "content": "# Deployment Guide\n\n## Prerequisites\n\n- Docker installed\n- Access to production cluster",
    "company_slug": "acme",
    "project_slug": "web-app"
  }'

Update Wiki Page

Updates an existing wiki page.

PUT /wiki/pages/{uuid}

Path Parameters

Parameter	Type	Description
`uuid`	string	Wiki page UUID

Request Body

Field	Type	Required	Description
`company_slug`	string	Yes	Workspace identifier
`project_slug`	string	Yes	Project identifier
`title`	string	No	Updated page title
`content`	string	No	Updated page content (markdown)

Delete Wiki Page

Permanently deletes a wiki page.

DELETE /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}

Path Parameters

Parameter	Type	Description
`uuid`	string	Wiki page UUID

Page Revisions

Returns the revision history for a wiki page.

GET /wiki/pages/{uuid}/revisions?company_slug={slug}&project_slug={slug}

Path Parameters

Parameter	Type	Description
`uuid`	string	Wiki page UUID

Restore Revision

Restores a wiki page to a previous revision.

POST /wiki/pages/{uuid}/restore/{revision_uuid}?company_slug={slug}&project_slug={slug}

Path Parameters

Parameter	Type	Description
`uuid`	string	Wiki page UUID
`revision_uuid`	string	Revision UUID to restore

Search Wiki

Searches wiki pages by content or title.

GET /wiki/pages/search?company_slug={slug}&project_slug={slug}&q={query}

Query Parameters

Parameter	Type	Required	Description
`company_slug`	string	Yes	Workspace identifier
`project_slug`	string	Yes	Project identifier
`q`	string	Yes	Search query (min 2 characters)
`limit`	integer	No	Max results (default 20, max 50)

Example Request

curl -X GET "https://services.gitscrum.com/wiki/pages/search?company_slug=acme&project_slug=web-app&q=deployment" \
  -H "Authorization: Bearer {token}"

Field Reference

Field	Type	Description
`uuid`	string	Unique page identifier
`title`	string	Page title
`content`	string	Page content (markdown)
`parent_uuid`	string	Parent page UUID (null for root pages)
`user`	object	Author (`username`, `name`)
`revisions_count`	integer	Number of revisions
`created_at`	string	Creation timestamp
`updated_at`	string	Last update timestamp