User Stories

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.

User stories representam requisitos ou funcionalidades voltadas ao usuário. Tarefas podem ser agrupadas sob user stories para organizar o trabalho em torno de resultados entregáveis.

Listar User Stories

Retorna user stories de um projeto.

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

Parâmetros de Query

Exemplo de Requisição

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

Exemplo de Resposta

{
  "data": [
    {
      "slug": "as-a-user-i-can-reset-my-password",
      "title": "As a user, I can reset my password",
      "description": "Users need to recover access when they forget their password.",
      "priority": {
        "id": 2,
        "title": "Medium"
      },
      "acceptance_criteria": "- Reset email sent within 30s\n- Link expires after 24h\n- Password must meet complexity rules",
      "tasks_count": 5,
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "created_at": "2026-01-15T08:00:00Z"
    }
  ]
}

Obter User Story

Retorna detalhes completos de uma única user story.

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

Parâmetros de Caminho

Criar User Story

Cria uma nova user story.

POST /user-stories

Corpo da Requisição

Exemplo de Requisição

curl -X POST "https://services.gitscrum.com/user-stories" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "As a manager, I can view team velocity",
    "company_slug": "acme",
    "project_slug": "web-app",
    "description": "Managers need a velocity chart to track team output per sprint.",
    "acceptance_criteria": "- Chart shows last 10 sprints\n- Displays story points and task count"
  }'

Atualizar User Story

Atualiza uma user story existente.

PUT /user-stories/{slug}

Corpo da Requisição

Aceita companyslug, projectslug e os mesmos campos opcionais de Criar User Story.

Excluir User Story

Exclui permanentemente uma user story. As tarefas vinculadas a esta story são preservadas, mas desvinculadas.

DELETE /user-stories/{slug}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Referência de Campos