Get Share Options

Retrieve options for a public form or task share. Supported option types are equipment, documents, jobs, contractors, and subForm.

For subForm, omit id to list available templates. Each option contains only value (template ID), label (published title), and meta.type (form or corrective-action). Template definitions are excluded from the list. Lists use the schema reference document and include available published forms and corrective actions in the share's target. The UI filters options by the field's type and configured IDs, when present. Lists require no query string.

{
  "options": [
    { "value": "template-id", "label": "Inspection", "meta": { "type": "form" } }
  ]
}

Use ?id=template-id to fetch one template when a subform instance needs it:

GET /api/{targetPath}/share/:shareId/options/subForm?id=template-id

The response contains options: [] and subForm: { id, build }. build contains the published definition; unpublished changes are excluded.

Subform requests require an active, unexpired public form or task share. Removed, disabled, unpublished, and unsupported template types are excluded. A request for an unavailable ID fails. The same list and ID requests are used at every nesting level, without passing parent context.