Skip to content
HeyX API

List External Advanced Tasks

Required scope: advanced_task:read

This endpoint only returns advanced-task instances whose snapshotted type is external. The default status is PUBLIC_ADVANCED_TASK_STATUS_PENDING, making the endpoint suitable for integrations that poll for open work.

Results use stable newest-first cursor pagination. Pass nextCursor from one response as cursor on the next request. pageSize defaults to 50 and is capped at 100.

Generated Reference
POST /public-api/publicapi.v1.AdvancedTaskService/ListAdvancedTaskInstances

Lists external advanced-task instances, pending by default.

Request ListAdvancedTaskInstancesRequest
Response ListAdvancedTaskInstancesResponse

ListAdvancedTaskInstancesRequest

Field Type Description
status AdvancedTaskStatus Defaults to pending so integrations can pull open work.
page_size int32
cursor optional string

ListAdvancedTaskInstancesResponse

Field Type
instances repeated AdvancedTaskInstance
next_cursor optional string

Related Types

AdvancedTaskInstance

Field Type
id string
advanced_task_id optional string
name string
description string
external_key string
external_description string
status AdvancedTaskStatus
created_at int64
updated_at int64
completed_at optional int64
portfolio_id string
problem_id optional string
work_order_id optional string
parent_title string
portfolio_title string
portfolio_reference string
completion_evidence google.protobuf.Struct

Request

Section titled “Request”
{
  "status": "PUBLIC_ADVANCED_TASK_STATUS_PENDING",
  "pageSize": 50
}

Response

Section titled “Response”
{
  "instances": [
    {
      "id": "663f561f-3810-4d28-8bd9-e6024ebfee32",
      "advancedTaskId": "56dc3803-036f-48b2-8634-e7110104ab28",
      "name": "Upload inspection result",
      "description": "Upload the signed inspection result to the source system.",
      "externalKey": "inspection.upload",
      "externalDescription": "Requires a signed report URL.",
      "status": "PUBLIC_ADVANCED_TASK_STATUS_PENDING",
      "createdAt": "1784548800",
      "updatedAt": "1784548800",
      "portfolioId": "870772a1-d93d-4594-8274-26d9dfc69f46",
      "problemId": "f2816cdf-a63a-4d8c-8541-accc830689fd",
      "parentTitle": "Inspection report missing",
      "portfolioTitle": "Solar installation",
      "portfolioReference": "P-1042",
      "completionEvidence": {}
    }
  ],
  "nextCursor": "eyJjcmVhdGVkX2F0IjoiLi4uIn0"
}
HeyX API