Get form

Retrieve a form by ID

get

Use the select query parameter to specify which fields to include.

Path parameters

idstringRequired

The form ID.

Query parameters

selectstringOptional

Optional select statement to filter fields.

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

Gets or sets the description associated with the form.

statusstring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the queue has been marked as deleted.

403

Forbidden

application/json

404

Not Found

application/json

get/public/v1/helpdesk/forms/{id}

HTTPcURLJavaScriptPython

GET /public/v1/helpdesk/forms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-22T11:09:58.817Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-22T11:09:58.817Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-07-22T11:09:58.817Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "published": {
      "at": "2026-07-22T11:09:58.817Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unpublished": {
      "at": "2026-07-22T11:09:58.817Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "description": "text",
  "status": "Unpublished",
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "statistics": {
    "groups": 1,
    "parameters": 1
  },
  "isDeleted": true
}