GitScrum / Docs

Búsqueda

Busca en todos los recursos de un workspace. Encuentra tareas, páginas wiki, discusiones y más.

REST API — Todos los endpoints requieren autenticación mediante Bearer token. Incluye Authorization: Bearer {token} en cada solicitud. Los tokens se gestionan en Configuración de GitScrum → API. Base URL: https://services.gitscrum.com — Todas las rutas de solicitud en esta documentación son relativas a esta URL base.

El endpoint de búsqueda proporciona una forma unificada de encontrar recursos en todo un workspace, devolviendo resultados agrupados de tareas, páginas wiki, discusiones, historias de usuario, sprints y más.

Buscar

Realiza una búsqueda entre recursos dentro de un workspace.

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

Parámetros de query

ParámetroTipoRequeridoDescripción
company_slugstringIdentificador del workspace
qstringConsulta de búsqueda (mínimo 2 caracteres)

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "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": []
  }
}

Estructura de respuesta

Los resultados se agrupan por tipo de recurso. Cada grupo contiene un array de elementos coincidentes. Un array vacío indica que no hay coincidencias para ese tipo.

GrupoDescripción
tasksTareas coincidentes en todos los proyectos
wikiPáginas wiki coincidentes
discussionsCanales de discusión y mensajes coincidentes
user_storiesHistorias de usuario coincidentes
sprintsSprints coincidentes

Referencia de campos

Cada elemento del resultado contiene:

CampoTipoDescripción
typestringTipo de recurso (task, wiki, discussion, user_story, sprint)
titlestringTítulo del recurso
slug o uuidstringIdentificador único
descriptionstringExtracto o descripción
matched_fieldstringQué campo coincidió con la consulta (title, content, description)