GitScrum / Docs

Workflows

Obtenha colunas de workflow do projeto (estados do quadro Kanban). Use IDs de workflow para mover tarefas entre colunas.

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.

Workflows definem as colunas do quadro Kanban de um projeto. Cada coluna representa um estado de tarefa (ex.: Backlog, Em Progresso, Concluído). Use IDs de workflow ao mover tarefas entre colunas.

Listar workflows

GET /projects-workflows?companyslug={slug}&projectslug={slug}

Retorna as colunas do quadro Kanban de um projeto.

Parâmetros de query

ParâmetroTipoObrigatórioDescrição
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
curl -X GET "https://services.gitscrum.com/projects-workflows?company_slug=acme-corp&project_slug=web-platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Resposta 200 OK

{
  "data": [
    {
      "id": 1,
      "slug": "backlog",
      "title": "Backlog",
      "color": "#6B7280",
      "state": 0,
      "position": 1,
      "default": true
    },
    {
      "id": 2,
      "slug": "in-progress",
      "title": "In Progress",
      "color": "#3B82F6",
      "state": 0,
      "position": 2,
      "default": false
    },
    {
      "id": 3,
      "slug": "in-review",
      "title": "In Review",
      "color": "#F59E0B",
      "state": 0,
      "position": 3,
      "default": false
    },
    {
      "id": 4,
      "slug": "done",
      "title": "Done",
      "color": "#10B981",
      "state": 1,
      "position": 4,
      "default": false
    }
  ]
}

Criar coluna de workflow

POST /projects-workflows

Adiciona uma nova coluna ao quadro do projeto.

Corpo da requisição

CampoTipoObrigatórioDescrição
titlestringSimNome da coluna
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
colorstringNãoCor hexadecimal sem #
stateintegerNão0 = aberto, 1 = concluído
curl -X POST https://services.gitscrum.com/projects-workflows \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "QA Review",
    "company_slug": "acme-corp",
    "project_slug": "web-platform",
    "color": "F59E0B",
    "state": 0
  }'

Atualizar coluna de workflow

PUT /projects-workflows/{id}

Atualiza uma coluna de workflow.

Parâmetros de caminho

ParâmetroTipoObrigatórioDescrição
idintegerSimID da coluna de workflow

Corpo da requisição

CampoTipoObrigatórioDescrição
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
titlestringNãoNome da coluna
colorstringNãoCor hexadecimal sem #

Atualizar limite WIP

PUT /projects-workflows/{id}/wip

Define o limite de trabalho em progresso para uma coluna.

Parâmetros de caminho

ParâmetroTipoObrigatórioDescrição
idintegerSimID da coluna de workflow

Corpo da requisição

CampoTipoObrigatórioDescrição
wipintegerSimMáximo de tarefas permitidas (0 = ilimitado)
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Excluir coluna de workflow

DELETE /projects-workflows/{id}?companyslug={slug}&projectslug={slug}

Remove uma coluna do quadro do projeto. Tarefas na coluna são movidas para a coluna padrão.

Parâmetros de caminho

ParâmetroTipoObrigatórioDescrição
idintegerSimID da coluna de workflow

Referência de campos

CampoTipoDescrição
idintegerID da coluna de workflow — usado para mover tarefas
slugstringIdentificador da coluna amigável para URL
titlestringNome de exibição da coluna
colorstringCor da coluna (hex)
stateinteger0 = aberto, 1 = concluído
positionintegerPosição da coluna no quadro (1 = mais à esquerda)
defaultbooleanSe esta é a coluna padrão para novas tarefas

Movendo tarefas entre colunas

Use o id do workflow ao atualizar a coluna de uma tarefa:

curl -X PUT https://services.gitscrum.com/tasks/{task_uuid} \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_slug": "acme-corp",
    "project_slug": "web-platform",
    "workflow_id": 2
  }'

Isso move a tarefa para a coluna "In Progress" (ID 2).

IDs de workflow são específicos do projeto. Sempre busque a lista de workflows do projeto de destino antes de mover tarefas.