GitScrum / Docs

Comments

Add, list, and update comments on tasks. Support for rich text content.

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.

Comments allow team members to discuss tasks, share updates, and track decisions directly on work items.

List Comments

Returns comments for a specific task.

GET /comments?company_slug={slug}&project_slug={slug}&task_uuid={uuid}

Query Parameters

ParameterTypeRequiredDescription
company_slugstringYesWorkspace identifier
project_slugstringYesProject identifier
task_uuidstringYesTask UUID

Example Request

curl -X GET "https://services.gitscrum.com/comments?company_slug=acme&project_slug=web-app&task_uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer {token}"

Example Response

{
  "data": [
    {
      "id": 1024,
      "comment": "<p>API integration is complete. Ready for review.</p>",
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "created_at": "2026-02-05T09:15:00Z",
      "updated_at": "2026-02-05T09:15:00Z"
    }
  ]
}

Create Comment

Adds a comment to a task.

POST /comments

Request Body

FieldTypeRequiredDescription
commentstringYesComment text (HTML or markdown)
company_slugstringYesWorkspace identifier
project_slugstringYesProject identifier
task_uuidstringYesTask UUID

Example Request

curl -X POST "https://services.gitscrum.com/comments" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Blocked by missing API credentials. Reaching out to DevOps.",
    "company_slug": "acme",
    "project_slug": "web-app",
    "task_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Update Comment

Updates an existing comment.

PUT /comments/{id}

Path Parameters

ParameterTypeDescription
idintegerComment ID

Request Body

FieldTypeRequiredDescription
commentstringYesUpdated comment text
company_slugstringYesWorkspace identifier
project_slugstringYesProject identifier

Delete Comment

Deletes a comment.

DELETE /comments/{id}?company_slug={slug}&project_slug={slug}

Path Parameters

ParameterTypeDescription
idintegerComment ID

Field Reference

FieldTypeDescription
idintegerComment identifier
commentstringComment content (HTML)
userobjectAuthor (username, name, avatar)
created_atstringCreation timestamp
updated_atstringLast update timestamp