Pesquisa

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.

O endpoint de pesquisa fornece uma forma unificada de encontrar recursos em todo o workspace, retornando resultados agrupados de tarefas, páginas wiki, discussões, user stories, sprints e mais.

Pesquisar

Realiza uma pesquisa entre recursos dentro de um workspace.

GET /search?company_slug={slug}&q={query}

Parâmetros de Query

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/search?company_slug=acme&q=authentication" \
  -H "Authorization: Bearer {token}"

Exemplo de Resposta

{
  "data": {
    "tasks": [
      {
        "type": "task",
        "title": "Implement user authentication",
        "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "description": "Add JWT-based authentication flow",
        "matched_field": "title",
        "project": {
          "slug": "web-app",
          "name": "Web App"
        }
      }
    ],
    "wiki": [
      {
        "type": "wiki",
        "title": "Authentication Architecture",
        "uuid": "d4e5f6a7-b8c9-0123-def0-123456789abc",
        "description": "Overview of the auth system design...",
        "matched_field": "title"
      }
    ],
    "discussions": [
      {
        "type": "discussion",
        "title": "Auth token refresh strategy",
        "uuid": "e5f6a7b8-c9d0-1234-ef01-23456789abcd",
        "description": "Discussing best approach for token refresh...",
        "matched_field": "content"
      }
    ],
    "user_stories": [],
    "sprints": []
  }
}

Estrutura da Resposta

Os resultados são agrupados por tipo de recurso. Cada grupo contém um array de itens correspondentes. Um array vazio indica que não há correspondências para aquele tipo.

Referência de Campos

Cada item do resultado contém: