GitScrum / Docs

Início Rápido

Comece com a API do GitScrum em 5 minutos. Liste workspaces, busque projetos e crie sua primeira tarefa.

REST API — Todos os endpoints requerem autenticação via Bearer token. Inclua Authorization: Bearer {token} em cada requisição. Os tokens são gerenciados em Configurações do GitScrum → API. Base URL: https://services.gitscrum.com — Todos os caminhos de requisição nesta documentação são relativos a esta URL base.

Crie sua primeira tarefa via API em 5 minutos.

Pré-requisitos

  • Uma conta GitScrum com pelo menos um workspace e projeto
  • Seu token de API (veja Autenticação)

Passo 1 — Obtenha seu token de API

Exporte seu token como variável de ambiente:

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

Passo 2 — Liste seus workspaces

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

Resposta

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

Copie o valor do slug — você precisará dele nos próximos passos.

Passo 3 — Liste os projetos

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

Resposta

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

Copie o slug do projeto para o próximo passo.

Passo 4 — Crie uma tarefa

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"
  }'

Resposta 201 Created

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

Passo 5 — Verifique a tarefa

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

Resposta

{
  "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"
  }
}

Sua tarefa agora está visível no quadro Kanban do GitScrum.

Próximos passos