API Reference
Dashform's v2 resource API for Organizations and Forms, 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.
List the caller's Organizations
List a page of Organizations the credential's user belongs to, oldest first. Follow nextPageToken to read subsequent pages.
Get an Organization
Reads one Organization the caller is a member of.