Issues API

Create and list product issues via the REST API.

The Issues API lets you create and retrieve product issues - bugs, feature requests, and change requests - that are tracked across your project.

Authentication required. All requests must include a valid API key in the Authorization header. See Authentication for details.

Base URL

https://your-hissuno-instance.com

List issues

GET /api/issues?projectId=YOUR_PROJECT_ID

Returns a paginated list of issues for the specified project. Supports filtering by type, priority, status, and RICE metric levels.

Query parameters

ParameterTypeRequiredDescription
projectIdstringYesThe project to list issues for
typestringNoFilter by issue type - bug, feature_request, or change_request
prioritystringNoFilter by priority - low, medium, or high
statusstringNoFilter by status - open, ready, in_progress, resolved, or closed
searchstringNoFree-text search across issue title and description
showArchivedbooleanNoInclude archived issues. Defaults to false
reachLevelstringNoFilter by reach metric level - low, medium, or high
impactLevelstringNoFilter by impact metric level - low, medium, or high
confidenceLevelstringNoFilter by confidence metric level - low, medium, or high
effortLevelstringNoFilter by effort metric level - low, medium, or high
productScopeIdsstringNoComma-separated list of product scope IDs to filter by
goalIdstringNoFilter to issues aligned with a specific goal
limitintegerNoMaximum number of issues to return
offsetintegerNoNumber of issues to skip for pagination

Example request

curl -X GET "https://your-hissuno-instance.com/api/issues?projectId=YOUR_PROJECT_ID&type=bug&status=open&limit=20" \
  -H "Authorization: Bearer hiss_your_api_key"

Example response

{
  "issues": [
    {
      "id": "iss_abc123",
      "project_id": "proj_xyz",
      "type": "bug",
      "title": "Export button unresponsive on Chrome",
      "description": "Multiple users report that the CSV export button does not trigger a download on Chrome 120+.",
      "priority": "high",
      "priority_manual_override": false,
      "status": "open",
      "upvote_count": 4,
      "brief": null,
      "is_archived": false,
      "custom_fields": {},
      "impact_score": 4,
      "reach_score": 3,
      "confidence_score": 5,
      "effort_score": 2,
      "created_at": "2026-01-10T09:00:00.000Z",
      "updated_at": "2026-01-15T11:00:00.000Z"
    }
  ],
  "total": 1
}

Create an issue

POST /api/issues?projectId=YOUR_PROJECT_ID

Creates a new issue for the specified project. Requires type, title, and description.

Query parameters

ParameterTypeRequiredDescription
projectIdstringYesThe project to create the issue in

Request body

FieldTypeRequiredDescription
typestringYesIssue type - bug, feature_request, or change_request
titlestringYesShort title describing the issue
descriptionstringYesDetailed description of the issue
prioritystringNoPriority level - low, medium, or high. Defaults to medium
session_idsstring[]NoArray of session IDs to link as evidence for this issue
product_scope_idstringNoProduct area ID to associate with this issue
custom_fieldsobjectNoArbitrary key-value data for custom fields

Example request

curl -X POST "https://your-hissuno-instance.com/api/issues?projectId=YOUR_PROJECT_ID" \
  -H "Authorization: Bearer hiss_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "bug",
    "title": "Export button unresponsive on Chrome",
    "description": "Clicking the CSV export button on the reports page does nothing in Chrome 120+. Works in Firefox and Safari.",
    "priority": "high",
    "session_ids": ["sess_abc123", "sess_def456"]
  }'

Example response

{
  "issue": {
    "id": "iss_new789",
    "project_id": "proj_xyz",
    "type": "bug",
    "title": "Export button unresponsive on Chrome",
    "description": "Clicking the CSV export button on the reports page does nothing in Chrome 120+. Works in Firefox and Safari.",
    "priority": "high",
    "priority_manual_override": false,
    "status": "open",
    "upvote_count": 0,
    "brief": null,
    "is_archived": false,
    "custom_fields": {},
    "created_at": "2026-01-16T14:00:00.000Z",
    "updated_at": "2026-01-16T14:00:00.000Z"
  }
}

Error responses

All endpoints return errors in the following format:

{
  "error": "Description of the problem."
}
StatusMeaning
400Missing or invalid parameters (e.g., missing projectId, type, title, or description)
401Missing or invalid API key
403API key does not have access to this project
500Internal server error