Issues API

Endpoints for submitting and retrieving issue reports.

Issues API

The API is not yet live. Endpoint paths below are illustrative and subject to change.

Submit an issue

[PLACEHOLDER: Confirm exact endpoint path, e.g. POST /v1/issues]

Request body:

[PLACEHOLDER: Confirm required and optional fields. Expected shape based on platform schema:]

{
  "title": "App crashes when tapping login button",
  "description": "Steps to reproduce: open app, tap Login...",
  "category": "crash",
  "priority": "high",
  "appVersion": "1.2.0",
  "buildNumber": "47",
  "osVersion": "iOS 17.4",
  "deviceModel": "iPhone 15 Pro",
  "platform": "ios",
  "branch": "main"
}

When using the Flutter SDK, all device metadata fields are populated automatically. You only need to provide title and optionally description and category when submitting via the SDK UI.

Response:

[PLACEHOLDER: Confirm response shape. Expected:]

{
  "id": "abc123",
  "issueNumber": 42,
  "title": "App crashes when tapping login button",
  "status": "open",
  "createdAt": "2026-05-01T10:30:00Z"
}

Retrieve an issue

[PLACEHOLDER: Confirm exact endpoint path, e.g. GET /v1/issues/:id]

List issues

[PLACEHOLDER: Confirm exact endpoint path and supported query parameters, e.g. GET /v1/issues?projectId=...&status=open&page=1]

Issue categories

Value	Description
bug	General bug or unexpected behaviour
crash	Application crash or fatal error
performance	Slowness, jank, or resource usage
ui_ux	Visual or interaction problem
security	Security vulnerability — handle with care

Issue statuses

Value	Description
open	Newly submitted, not yet reviewed
acknowledged	Seen by the team
in_progress	Actively being worked on
resolved	Fix implemented
closed	Closed without a fix
wontfix	Acknowledged but will not be addressed

← Previous

iOS SDK

Projects