API Reference

Dashform's v1 resource API for Organizations, Forms, and Replies, generated from the OpenAPI document the server itself serves.

List the Forms of an Organization

Lists the Organization's Forms, most recently updated first. Page with pageSize and the nextPageToken the response carries, and narrow the page with filter and orderBy.

Create a Form

Creates a Form in the Organization. The server assigns the Form's path, public id, and timestamps, so the create envelope carries none of them, and a new Form is a draft until it is published. Set validateOnly to check the envelope without writing anything.

Get a Form

Reads one Form. The Form carries its current draft; live says whether one of its Revisions is published, and the published Revision itself is addressed under the Form.

Update a Form

Updates the fields the patch names on the Form's draft and leaves the rest alone. Server-owned fields are not part of the patch. An edit reaches respondents only once the Form is published. Set validateOnly to check the patch without writing anything.

Delete a Form

Deletes the Form. The response is empty, and a later read answers 404. Set validateOnly to check the request without deleting anything.

Publish the Form's current draft

Publishes the Form's current draft as a new Revision, which becomes the one respondents see. Set validateOnly to check the draft without publishing it.

Get a published Form Revision

Reads the live Form Revision of a published Form without a credential: the Form as it was published, including the questions it asks. Address the Form by its public id under the wildcard Organization, as its public URL does. Only the live Revision is served; any other Revision is refused as a bad request, and a Form that was never published answers not found.

List the Replies to a Form Revision

Lists the Replies to a Form Revision, most recently created first. A Reply belongs to the Revision it answered, so address every Revision of the Form with the wildcard -. Page with pageSize and the nextPageToken the response carries, and narrow the page with filter and orderBy: filter completeTime:* for the Completed Replies only, and end a custom orderBy with path so pages never repeat or skip a Reply. Needs permission to read the Organization's Replies.

Submit a Reply

Submits a Completed Reply to the live Form Revision of a published Form without a credential, and answers with the stored Reply. Address the Form as the Form Revision read does. The answers are validated against the Form exactly as the Form's own page validates them. The Reply is recorded as filled by an agent, and its Ending is the one the Form's Branches resolve from the answers. Completing it fires the Form's integrations.

Create a Destination

Creates a Destination on the Form, such as the one Zapier creates when a Zap turns on. Only the `zapier:send-reply` kind is accepted, and only for an Organization whose plan includes Zapier. From then on each Completed Reply of the Form is POSTed to the Destination's URL as a Delivery, with retries, pauses, and replay. The server assigns the Destination's path; a URL that answers 410 pauses the Destination. Set validateOnly to check the request, the plan included, without creating anything.