Epics

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.

Epics are high-level initiatives that group related user stories. Use epics to organize large features or project phases that span multiple sprints.

List Epics

Returns epics for a project.

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

Query Parameters

Example Request

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

Example Response

{
  "data": [
    {
      "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "title": "User Onboarding",
      "description": "Complete onboarding flow including signup, verification, and tutorial.",
      "color": "8E44AD",
      "user_stories_count": 4,
      "created_at": "2026-01-10T12:00:00Z"
    }
  ]
}

Create Epic

Creates a new epic.

POST /user-story-epics

Request Body

Example Request

curl -X POST "https://services.gitscrum.com/user-story-epics" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Billing & Payments",
    "company_slug": "acme",
    "project_slug": "web-app",
    "description": "All billing, subscription, and payment-related stories.",
    "color": "E67E22"
  }'

Update Epic

Updates an existing epic.

PUT /user-story-epics/{uuid}

Path Parameters

Request Body

Delete Epic

Permanently deletes an epic. User stories linked to this epic are preserved but unlinked.

DELETE /user-story-epics/{uuid}?company_slug={slug}&project_slug={slug}

Path Parameters

Field Reference