For the complete documentation index, see llms.txt. This page is also available as Markdown.

List cases

get
Responses
200

OK

application/json
get/public/v1/helpdesk/cases
GET /public/v1/helpdesk/cases HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "updated": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "processed": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "queried": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "transferred": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        },
        "completed": {
          "at": "2026-01-01T00:00:00.000Z",
          "by": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1
          }
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "revision": 1,
      "chat": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "description": "text",
        "type": "Direct",
        "participants": [
          {
            "id": "text",
            "revision": 1,
            "muted": true,
            "status": "Active"
          }
        ],
        "lastMessage": {
          "id": "text",
          "revision": 1,
          "content": "text",
          "visibility": "Public",
          "isDeleted": true
        },
        "attachments": [
          {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "file": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2026-01-01T00:00:00.000Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                },
                "updated": {
                  "at": "2026-01-01T00:00:00.000Z",
                  "by": {
                    "id": "text",
                    "name": "text",
                    "icon": "text",
                    "revision": 1
                  }
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Icon",
              "filename": "report.pdf",
              "size": 102400,
              "contentType": "application/pdf"
            }
          }
        ]
      },
      "reporter": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "activated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "blocked": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "name": "text",
        "blockedReason": "text",
        "email": "text",
        "status": "text",
        "identity": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1
        },
        "directories": [
          {
            "id": "text",
            "revision": 1
          }
        ],
        "chat": true,
        "optOuts": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "lastUsed": "2026-01-01T00:00:00.000Z"
          }
        ],
        "user": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "email": "text",
          "status": "text",
          "phone": {
            "prefix": "text",
            "number": "text"
          },
          "firstName": "text",
          "lastName": "text",
          "lastLoginAt": "2026-01-01T00:00:00.000Z",
          "settings": {
            "cultureCode": "text",
            "dateFormat": "text",
            "languageCode": "text",
            "numberFormat": {
              "decimalSeparator": "text",
              "groupSeparator": "text"
            },
            "timeFormat": "text",
            "timeZone": "text",
            "optOuts": {
              "objectTypes": [
                "text"
              ]
            }
          },
          "accounts": [
            {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            }
          ],
          "currentAccount": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          }
        }
      },
      "assignee": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "activated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "blocked": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "revision": 1,
        "name": "text",
        "blockedReason": "text",
        "email": "text",
        "status": "text",
        "identity": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1
        },
        "directories": [
          {
            "id": "text",
            "revision": 1
          }
        ],
        "chat": true,
        "optOuts": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "lastUsed": "2026-01-01T00:00:00.000Z"
          }
        ],
        "user": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "email": "text",
          "status": "text",
          "phone": {
            "prefix": "text",
            "number": "text"
          },
          "firstName": "text",
          "lastName": "text",
          "lastLoginAt": "2026-01-01T00:00:00.000Z",
          "settings": {
            "cultureCode": "text",
            "dateFormat": "text",
            "languageCode": "text",
            "numberFormat": {
              "decimalSeparator": "text",
              "groupSeparator": "text"
            },
            "timeFormat": "text",
            "timeZone": "text",
            "optOuts": {
              "objectTypes": [
                "text"
              ]
            }
          },
          "accounts": [
            {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1,
              "type": "Client",
              "status": "Active"
            }
          ],
          "currentAccount": {
            "id": "text",
            "name": "text",
            "icon": "text",
            "revision": 1,
            "type": "Client",
            "status": "Active"
          }
        }
      },
      "account": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "text",
        "website": "text",
        "description": "text",
        "groups": [
          {
            "id": "text",
            "name": "text",
            "revision": 1,
            "description": "text",
            "logo": "text",
            "isDefault": true
          }
        ],
        "eligibility": {
          "client": true,
          "partner": true
        },
        "defaultLanguageCode": "text"
      },
      "queue": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "updated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "deleted": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "activated": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          },
          "disabled": {
            "at": "2026-01-01T00:00:00.000Z",
            "by": {
              "id": "text",
              "name": "text",
              "icon": "text",
              "revision": 1
            }
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "icon": "text",
        "revision": 1,
        "longDescription": "text",
        "shortDescription": "text",
        "externalId": "text",
        "status": "Disabled",
        "default": true,
        "internal": true,
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            },
            "updated": {
              "at": "2026-01-01T00:00:00.000Z",
              "by": {
                "id": "text",
                "name": "text",
                "icon": "text",
                "revision": 1
              }
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "icon": "text",
          "revision": 1,
          "type": "Client",
          "status": "Active",
          "externalIds": {
            "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
          },
          "externalId": "text",
          "externalName": "text",
          "address": {
            "addressLine1": "text",
            "addressLine2": "text",
            "postCode": "text",
            "city": "text",
            "state": "text",
            "country": "text"
          },
          "technicalSupportEmail": "text",
          "website": "text",
          "description": "text",
          "groups": [
            {
              "id": "text",
              "name": "text",
              "revision": 1,
              "description": "text",
              "logo": "text",
              "isDefault": true
            }
          ],
          "eligibility": {
            "client": true,
            "partner": true
          },
          "defaultLanguageCode": "text"
        },
        "statistics": {
          "totalCases": 1,
          "openCases": 1
        },
        "isDeleted": true
      },
      "status": "Processing",
      "queryPrompt": "text",
      "parameters": [
        {
          "id": "text",
          "name": "text",
          "externalId": "text",
          "type": "SingleLineText",
          "multiple": true,
          "constraints": {
            "hidden": true,
            "readonly": true,
            "required": true,
            "capacity": {
              "min": 1,
              "max": 1
            },
            "visibility": "All"
          },
          "displayOrder": 1,
          "value": "[Circular Reference]",
          "displayValue": "text"
        }
      ],
      "sensitiveParameters": [
        {
          "id": "text",
          "name": "text",
          "externalId": "text",
          "type": "SingleLineText",
          "multiple": true,
          "constraints": {
            "hidden": true,
            "readonly": true,
            "required": true,
            "capacity": {
              "min": 1,
              "max": 1
            },
            "visibility": "All"
          },
          "displayOrder": 1,
          "value": "[Circular Reference]",
          "displayValue": "text"
        }
      ]
    }
  ]
}

Last updated

Was this helpful?