Épicos

Crie e gerencie épicos. Agrupe user stories em iniciativas de alto nível.

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.

Épicos são iniciativas de alto nível que agrupam user stories relacionadas. Use épicos para organizar grandes funcionalidades ou fases de projeto que abrangem múltiplos sprints.

Listar Épicos

Retorna épicos de um projeto.

GET /user-story-epics?company_slug={slug}&project_slug={slug}

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`company_slug`	string	Sim	Identificador do workspace
`project_slug`	string	Sim	Identificador do projeto

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/user-story-epics?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Exemplo de Resposta

{
  "data": [
    {
      "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "title": "User Onboarding",
      "description": "Complete onboarding flow including signup, verification, and tutorial.",
      "color": "8E44AD",
      "user_stories_count": 4,
      "created_at": "2026-01-10T12:00:00Z"
    }
  ]
}

Criar Épico

Cria um novo épico.

POST /user-story-epics

Corpo da Requisição

Campo	Tipo	Obrigatório	Descrição
`title`	string	Sim	Título do épico
`company_slug`	string	Sim	Identificador do workspace
`project_slug`	string	Sim	Identificador do projeto
`description`	string	Não	Descrição do épico (markdown)
`color`	string	Não	Cor hex sem `#` (ex.: `8E44AD`)

Exemplo de Requisição

curl -X POST "https://services.gitscrum.com/user-story-epics" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Billing & Payments",
    "company_slug": "acme",
    "project_slug": "web-app",
    "description": "All billing, subscription, and payment-related stories.",
    "color": "E67E22"
  }'

Atualizar Épico

Atualiza um épico existente.

PUT /user-story-epics/{uuid}

Parâmetros de Caminho

Parâmetro	Tipo	Descrição
`uuid`	string	UUID do épico

Corpo da Requisição

Campo	Tipo	Obrigatório	Descrição
`company_slug`	string	Sim	Identificador do workspace
`project_slug`	string	Sim	Identificador do projeto
`title`	string	Não	Título do épico atualizado
`description`	string	Não	Descrição atualizada
`color`	string	Não	Cor hex atualizada sem `#`

Excluir Épico

Exclui permanentemente um épico. User stories vinculadas a este épico são preservadas, mas desvinculadas.

DELETE /user-story-epics/{uuid}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Parâmetro	Tipo	Descrição
-----------	------	-----------	n	`uuid`	string	UUID do épico

Referência de Campos

Campo	Tipo	Descrição
`uuid`	string	Identificador único do épico
`title`	string	Título do épico
`description`	string	Descrição do épico (markdown)
`color`	string	Código de cor hex (sem `#`)
`userstoriescount`	integer	Número de user stories vinculadas
`created_at`	string	Timestamp de criação