Search

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

The search endpoint provides a unified way to find resources across an entire workspace, returning grouped results from tasks, wiki pages, discussions, user stories, sprints, and more.

Search

Performs a cross-resource search within a workspace.

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

Query Parameters

Example Request

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

Example Response

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

Response Structure

Results are grouped by resource type. Each group contains an array of matching items. An empty array indicates no matches for that type.

Field Reference

Each result item contains: