GitScrum / Docs

Tarefas

Crie, atualize, filtre, complete e gerencie tarefas. O recurso principal para itens de trabalho do projeto.

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.

Tarefas são os itens de trabalho principais no GitScrum. Cada tarefa pertence a um projeto e pode ser atribuída a usuários, organizada em sprints, vinculada a user stories, etiquetada e rastreada através de colunas Kanban.

Listar Tarefas (Filtro)

Retorna uma lista paginada de tarefas que correspondem aos filtros especificados.

GET /tasks?company_slug={slug}&project_slug={slug}

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
statusstringNãoFiltrar por status: todo, in-progress, done
sprintstringNãoSlug do sprint
user_storystringNãoSlug da user story
usersstringNãoUsernames separados por vírgula
labelsstringNãoTítulos de labels separados por vírgula
typestringNãoTítulo do tipo de tarefa
effortstringNãoTítulo do nível de esforço
workflowstringNãoTítulo da coluna Kanban
is_blockerbooleanNãoFiltrar tarefas bloqueadoras
is_archivedbooleanNãoFiltrar tarefas arquivadas
unassignedbooleanNãoApenas tarefas não atribuídas
created_atstringNãoIntervalo de datas YYYY-MM-DD=YYYY-MM-DD
closed_atstringNãoIntervalo de datas YYYY-MM-DD=YYYY-MM-DD
per_pageintegerNãoResultados por página (1–100, padrão 50)

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/tasks?company_slug=acme&project_slug=web-app&status=in-progress&per_page=10" \
  -H "Authorization: Bearer {token}"

Exemplo de Resposta

{
  "data": [
    {
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "WEB-42",
      "title": "Implement user authentication",
      "slug": "implement-user-authentication",
      "description": "Add JWT-based authentication flow",
      "state": 0,
      "workflow": {
        "id": 2,
        "title": "In Progress"
      },
      "type": {
        "id": 1,
        "title": "Feature",
        "color": "4A90D9"
      },
      "effort": {
        "id": 3,
        "title": "High"
      },
      "users": [
        {
          "username": "johndoe",
          "name": "John Doe"
        }
      ],
      "labels": [],
      "settings": {
        "is_blocker": false,
        "is_bug": false,
        "is_draft": false,
        "is_archived": false
      },
      "due_date": "2026-02-15",
      "created_at": "2026-01-20T10:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 10,
    "total": 42
  }
}

Obter Tarefa

Retorna detalhes completos de uma única tarefa.

GET /tasks/{uuid}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
uuidstringUUID da tarefa

Obter Tarefa por Código

Recupera uma tarefa usando seu código legível.

GET /tasks/by-code/{code}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
codestringCódigo da tarefa (ex.: PROJ-123)

Minhas Tarefas

Retorna tarefas atribuídas ao usuário autenticado em todos os workspaces.

GET /tasks/all-workspaces

Tarefas de Hoje

Retorna tarefas atribuídas ao usuário autenticado com prazo para hoje.

GET /tasks/my-today

Criar Tarefa

Cria uma nova tarefa no projeto especificado.

POST /tasks

Corpo da Requisição

CampoTipoObrigatórioDescrição
titlestringSimTítulo da tarefa
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
descriptionstringNãoDescrição da tarefa (markdown)
columnstringNãoNome da coluna Kanban (ex.: "In Progress")
workflow_idintegerNãoID da coluna Kanban (alternativa a column)
type_idintegerNãoID do tipo de tarefa
effort_idintegerNãoID do nível de esforço/prioridade
sprint_slugstringNãoSprint para atribuir a tarefa
userstoryslugstringNãoUser story para vincular
usernamesarrayNãoUsernames para atribuir
label_idsarrayNãoIDs de labels para anexar
due_datestringNãoPrazo (YYYY-MM-DD)
start_datestringNãoData de início (YYYY-MM-DD)
estimated_minutesintegerNãoEstimativa de tempo em minutos
is_blockerbooleanNãoMarcar como bloqueador
is_bugbooleanNãoMarcar como bug
parent_idstringNãoUUID da tarefa pai (cria subtarefa)

Exemplo de Requisição

curl -X POST "https://services.gitscrum.com/tasks" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Add password reset flow",
    "company_slug": "acme",
    "project_slug": "web-app",
    "column": "To Do",
    "type_id": 1,
    "usernames": ["johndoe"],
    "due_date": "2026-02-28",
    "estimated_minutes": 120
  }'

Exemplo de Resposta

{
  "data": {
    "uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "code": "WEB-43",
    "title": "Add password reset flow",
    "state": 0,
    "workflow": {
      "id": 1,
      "title": "To Do"
    },
    "due_date": "2026-02-28",
    "estimated_minutes": 120,
    "created_at": "2026-02-07T14:00:00Z"
  }
}

Atualizar Tarefa

Atualiza uma tarefa existente. Suporta atualização de título, descrição, datas, workflow, tipo, esforço, sprint, user story, bloqueador, bug, rascunho, arquivamento e campos de estimativa de tempo.

PUT /tasks/{uuid}

Corpo da Requisição

Aceita os mesmos campos opcionais de Criar Tarefa, mais companyslug e projectslug.

Exemplo de Requisição

curl -X PUT "https://services.gitscrum.com/tasks/b2c3d4e5-f6a7-8901-bcde-f12345678901" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_slug": "acme",
    "project_slug": "web-app",
    "column": "In Progress",
    "is_blocker": true
  }'

Excluir Tarefa

Exclui permanentemente uma tarefa. Esta ação não pode ser desfeita.

DELETE /tasks/{uuid}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
uuidstringUUID da tarefa
curl -X DELETE "https://services.gitscrum.com/tasks/b2c3d4e5-f6a7-8901-bcde-f12345678901?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Marcar Tarefa como Concluída

Alterna o estado de conclusão de uma tarefa.

PUT /tasks/{uuid}/done?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
uuidstringUUID da tarefa

Atualizar Estimativa

Atualiza os story points ou estimativa de uma tarefa.

PUT /tasks/{uuid}/estimative?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
uuidstringUUID da tarefa

Corpo da Requisição

CampoTipoObrigatórioDescrição
estimativestringSimValor de story points ou estimativa

Mover para Quadro

Move uma tarefa para um quadro de projeto diferente.

PUT /tasks/{uuid}/project_board?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
uuidstringUUID da tarefa

Corpo da Requisição

CampoTipoObrigatórioDescrição
board_uuidstringSimUUID do quadro de destino

Duplicar Tarefa

Cria uma cópia da tarefa especificada.

POST /tasks/{uuid}/duplicate?company_slug={slug}&project_slug={slug}

Mover Tarefa para Projeto

Move uma tarefa para um projeto diferente.

POST /tasks/{uuid}/move?company_slug={slug}&project_slug={slug}

Corpo da Requisição

CampoTipoObrigatórioDescrição
newprojectslugstringSimSlug do projeto de destino
newworkflowidintegerSimID da coluna Kanban de destino

Subtarefas

Listar Subtarefas

Retorna subtarefas de uma tarefa pai.

GET /tasks/{uuid}/sub-tasks?company_slug={slug}&project_slug={slug}

Vincular Subtarefa

Vincula uma tarefa existente como subtarefa.

POST /tasks/{uuid}/sub-tasks/{subtask_uuid}?company_slug={slug}&project_slug={slug}

Desvincular Subtarefa

Remove o relacionamento de subtarefa sem excluir a tarefa.

DELETE /tasks/{uuid}/sub-tasks/{subtask_uuid}?company_slug={slug}&project_slug={slug}

Subtarefas Disponíveis

Pesquisa tarefas que podem ser vinculadas como subtarefas.

GET /tasks/{uuid}/available-subtasks?company_slug={slug}&project_slug={slug}

Tarefas Relacionadas

Retorna tarefas relacionadas à tarefa especificada.

GET /tasks/{uuid}/related-tasks?company_slug={slug}&project_slug={slug}

Responsáveis

Atribuir Membro

Atribui um usuário a uma tarefa.

POST /task-assignees

Corpo da Requisição

CampoTipoObrigatórioDescrição
task_uuidstringSimUUID da tarefa
usernamestringSimUsername para atribuir
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Remover Membro

Remove um usuário de uma tarefa.

DELETE /task-assignees

Corpo da Requisição

CampoTipoObrigatórioDescrição
task_uuidstringSimUUID da tarefa
usernamestringSimUsername para remover
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Checklists

Listar Checklists

Retorna checklists de uma tarefa.

GET /task-checklists?task_uuid={uuid}&company_slug={slug}&project_slug={slug}

Criar Item de Checklist

Cria um novo item de checklist. Inclua parent_id para criar um sub-item.

POST /task-checklists

Corpo da Requisição

CampoTipoObrigatórioDescrição
titlestringSimTexto do item
task_uuidstringSimUUID da tarefa
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
parent_idintegerNãoID do item de checklist pai (para sub-itens)

Atualizar Item de Checklist

Atualiza o título de um item de checklist.

PUT /task-checklists/{id}

Corpo da Requisição

CampoTipoObrigatórioDescrição
titlestringSimTexto atualizado
company_slugstringSimIdentificador do workspace

Alternar Item de Checklist

Marca um item de checklist como concluído ou não concluído.

PUT /task-checklists/{id}/toggle

Excluir Item de Checklist

Remove um item de checklist.

DELETE /task-checklists/{id}?company_slug={slug}&project_slug={slug}

Labels de Tarefa

Listar Labels da Tarefa

Retorna labels anexadas a uma tarefa.

GET /task-labels?task_uuid={uuid}&company_slug={slug}&project_slug={slug}

Listar Labels Disponíveis

Retorna labels ainda não atribuídas à tarefa.

GET /task-labels/not-added?task_uuid={uuid}&company_slug={slug}&project_slug={slug}

Criar e Anexar Label

Cria uma nova label e a anexa à tarefa.

POST /task-labels

Corpo da Requisição

CampoTipoObrigatórioDescrição
titlestringSimNome da label
colorstringSimCor hexadecimal sem #
task_uuidstringSimUUID da tarefa
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Anexar Label

Anexa uma label existente a uma tarefa.

POST /task-labels/{label_id}/attach

Corpo da Requisição

CampoTipoObrigatórioDescrição
task_uuidstringSimUUID da tarefa
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Desanexar Label

Remove uma label de uma tarefa.

DELETE /task-labels/{label_id}/detach

Corpo da Requisição

CampoTipoObrigatórioDescrição
task_uuidstringSimUUID da tarefa
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Importar Tarefas

Pré-visualizar Importação

Faz upload de um arquivo CSV e retorna uma pré-visualização dos dados a importar.

POST /tasks/import/preview

Corpo da Requisição (multipart/form-data)

CampoTipoObrigatórioDescrição
filefileSimArquivo CSV
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Confirmar Importação

Confirma a importação e cria tarefas a partir dos dados pré-visualizados.

POST /tasks/import/confirm

Corpo da Requisição

CampoTipoObrigatórioDescrição
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
dataarraySimDados de importação mapeados da pré-visualização

Exportar Tarefas

Contagem de Tarefas

Retorna a contagem total de tarefas para exportação.

GET /{company_slug}/{project_slug}/tasks/count

Exportar como Excel

Faz download das tarefas como arquivo Excel.

GET /{company_slug}/{project_slug}/tasks/excel

Favoritos

Listar Favoritos

Retorna todas as tarefas favoritadas pelo usuário autenticado.

GET /favorites?company_slug={slug}

Alternar Favorito

Adiciona ou remove uma tarefa dos favoritos.

POST /favorites/{task_uuid}

Corpo da Requisição

CampoTipoObrigatórioDescrição
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Notificações

Retorna notificações relacionadas a tarefas para o usuário autenticado.

GET /tasks/notifications

Referência de Campos

CampoTipoDescrição
uuidstringIdentificador único
codestringCódigo legível (ex.: WEB-42)
titlestringTítulo da tarefa
slugstringIdentificador amigável para URL
descriptionstringDescrição da tarefa (markdown)
stateinteger0 = aberta, 1 = fechada
estimativestringStory points ou rótulo de estimativa
estimated_minutesintegerEstimativa de tempo em minutos
totaltrackedminutesintegerTempo total rastreado em minutos
parent_idstringUUID da tarefa pai (se subtarefa)
typeobjectTipo de tarefa (id, title, color)
effortobjectNível de esforço (id, title)
workflowobjectColuna Kanban (id, title)
labelsarrayLabels anexadas
userobjectCriador
usersarrayUsuários atribuídos
settingsobjectisblocker, isbug, isdraft, isarchived
statsobjectEstatísticas da tarefa
companyobjectReferência do workspace
projectobjectReferência do projeto
boardobjectReferência do quadro
sprintobjectReferência do sprint
user_storyobjectUser story vinculada
start_datestringData de início
due_datestringData de prazo
created_atstringTimestamp de criação