Skip to content
HeyX API

List Problems

Required scope: problem:read

Results are limited to the connected workspace and the API key creator’s current resource access. page defaults to 1, pageSize defaults to 25, and pageSize is capped at 100.

Generated Reference
POST /public-api/publicapi.v1.Problem/ListProblems

Lists problems visible to the API key actor, with bounded pagination. page defaults to 1 and page_size defaults to 25.

Request ListProblemsRequest
Response ListProblemsResponse

ListProblemsRequest

Field Type
status ProblemStatus
page int32
page_size int32
assignee_ids repeated string
severity_levels repeated int32
portfolio_ids repeated string
title_query string

ListProblemsResponse

Field Type
problems repeated Problem
total int32
page int32
page_size int32

Related Types

Problem

Field Type
id string
title string
description string
status ProblemStatus
severity int32
portfolio_id optional string
problem_template_id optional string
problem_template_name string
assignees repeated ProblemAssignee
labels repeated ProblemLabel
resolved_at optional int64
closed_at optional int64
archived_at optional int64
created_at int64
updated_at int64
total_tasks int32
completed_tasks int32

ProblemAssignee

Field Type
id string
display_name string
kind string

ProblemLabel

Field Type
id optional string
name string
color_hex string

Request

Section titled “Request”
{
  "status": "PUBLIC_PROBLEM_STATUS_OPEN",
  "page": 1,
  "pageSize": 25,
  "severityLevels": [2, 3],
  "portfolioIds": ["<portfolio-id>"],
  "titleQuery": "inspection"
}

Omit filters to list all visible problems within the page bounds.

HeyX API