Skip to main content
Documentation

Domain

Forms capabilities

5 capabilities, all acting on a form. A reference to one from another domain is spelled form_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.
CapabilityWhat it doesEffect
forms.listPOST /api/v1/forms/listList the shop's lead forms and how many have been submittedread-only
forms.getPOST /api/v1/forms/getGet one lead form, its steps and what each one asks forread-only
forms.funnelPOST /api/v1/forms/funnelShow where visitors give up on one lead form, step by stepread-only
forms.connectionsPOST /api/v1/forms/connectionsList the third-party forms posting straight into this pipelineread-only
forms.templatesPOST /api/v1/forms/templatesList the starter templates a new lead form can be built fromread-only

← Every domain