Quick Start

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.

Create your first task via the API in 5 minutes.

Prerequisites

• A GitScrum account with at least one workspace and project
• Your API token (see Authentication)

Step 1 — Get your API token

Export your token as an environment variable:

export GITSCRUM_TOKEN="your-api-token-here"

Step 2 — List your workspaces

curl -X GET https://services.gitscrum.com/workspaces \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "data": [
    {
      "slug": "acme-corp",
      "name": "Acme Corp",
      "logo": "https://cdn.gitscrum.com/logos/acme.png"
    }
  ]
}

Copy the slug value — you need it for the next steps.

Step 3 — List projects

curl -X GET "https://services.gitscrum.com/projects?company_slug=acme-corp" \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "data": [
    {
      "slug": "web-platform",
      "name": "Web Platform",
      "description": "Main product application",
      "visibility": "public"
    }
  ]
}

Copy the project slug for the next step.

Step 4 — Create a task

curl -X POST https://services.gitscrum.com/tasks \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "My first API task",
    "company_slug": "acme-corp",
    "project_slug": "web-platform"
  }'

Response 201 Created

{
  "data": {
    "uuid": "task-uuid-abc123",
    "title": "My first API task",
    "code": "WEB-42",
    "status": "todo",
    "created_at": "2026-02-07T10:30:00Z"
  }
}

Step 5 — Verify the task

curl -X GET https://services.gitscrum.com/tasks/task-uuid-abc123 \
  -H "Authorization: Bearer $GITSCRUM_TOKEN" \
  -H "Content-Type: application/json"

Response

{
  "data": {
    "uuid": "task-uuid-abc123",
    "title": "My first API task",
    "code": "WEB-42",
    "status": "todo",
    "workflow": {
      "title": "Backlog"
    },
    "project": {
      "slug": "web-platform",
      "name": "Web Platform"
    },
    "created_at": "2026-02-07T10:30:00Z"
  }
}

Your task is now visible on the Kanban board in GitScrum.

Next steps

• Tasks — Full task management (update, filter, assign, move)
• Projects — Project configuration and stats
• Sprints — Sprint planning and reports
• Time Tracking — Track time on tasks
• Error Handling — Handle errors gracefully