Projetos

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.

Projetos organizam tarefas, sprints e membros da equipe dentro de um workspace.

Listar projetos

GET /projects?company_slug={slug}

Retorna uma lista paginada de projetos em um workspace.

Parâmetros de query

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

Resposta 200 OK

{
  "data": [
    {
      "slug": "web-platform",
      "name": "Web Platform",
      "description": "Main product application",
      "logo": "https://cdn.gitscrum.com/projects/web.png",
      "visibility": "public",
      "is_private": false,
      "recurring": false,
      "owner": {
        "name": "Jane Smith",
        "username": "janesmith"
      },
      "created_at": "2025-06-15T09:00:00Z"
    }
  ]
}

Buscar projeto por nome

GET /projects?company_slug={slug}&name={name}

Pesquisa projetos por nome dentro de um workspace.

Parâmetros de query

curl -X GET "https://services.gitscrum.com/projects?company_slug=acme-corp&name=Web%20Platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Obter projeto

GET /projects/{slug}?company_slug={slug}

Retorna os detalhes completos do projeto.

Parâmetros de caminho

Parâmetros de query

curl -X GET "https://services.gitscrum.com/projects/web-platform?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Resposta 200 OK

{
  "data": {
    "slug": "web-platform",
    "name": "Web Platform",
    "description": "Main product application",
    "logo": "https://cdn.gitscrum.com/projects/web.png",
    "visibility": "public",
    "is_private": false,
    "recurring": false,
    "owner": {
      "name": "Jane Smith",
      "username": "janesmith"
    },
    "settings": {
      "default_workflow": "backlog",
      "task_prefix": "WEB"
    },
    "stats": {
      "tasks_count": 156,
      "completed_count": 98,
      "members_count": 8
    },
    "created_at": "2025-06-15T09:00:00Z"
  }
}

Criar projeto

POST /projects

Cria um novo projeto em um workspace.

Corpo da requisição

curl -X POST https://services.gitscrum.com/projects \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mobile App",
    "company_slug": "acme-corp",
    "description": "iOS and Android application",
    "visibility": "private"
  }'

Resposta 201 Created

{
  "data": {
    "slug": "mobile-app",
    "name": "Mobile App",
    "description": "iOS and Android application",
    "visibility": "private",
    "is_private": true,
    "created_at": "2026-02-07T10:00:00Z"
  }
}

Estatísticas do projeto

GET /projects/{slug}/stats?company_slug={slug}

Retorna estatísticas do projeto.

curl -X GET "https://services.gitscrum.com/projects/web-platform/stats?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Resposta 200 OK

{
  "data": {
    "tasks_count": 156,
    "completed_count": 98,
    "open_count": 58,
    "members_count": 8,
    "sprints_count": 6,
    "labels_count": 12
  }
}

Atualizar projeto

PUT /projects/{slug}

Atualiza um projeto existente.

Parâmetros de caminho

Corpo da requisição

curl -X PUT "https://services.gitscrum.com/projects/web-platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_slug": "acme-corp",
    "name": "Web Platform v2",
    "description": "Main product application - redesigned"
  }'

Excluir projeto

DELETE /projects/{slug}?company_slug={slug}

Exclui permanentemente um projeto e todos os seus dados. Esta ação não pode ser desfeita.

Parâmetros de caminho

curl -X DELETE "https://services.gitscrum.com/projects/web-platform?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}"

Duplicar projeto

POST /projects/{slug}/duplicate?company_slug={slug}

Cria uma cópia da estrutura do projeto incluindo workflows e configurações.

Parâmetros de caminho

curl -X POST "https://services.gitscrum.com/projects/web-platform/duplicate?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}"

Referência de campos