Skip to main content
A form collects answers from the people who fill it in, and each completed form is a submission. For fields and response details, see the API reference for forms, a single form, creating a form and form actions. To read submissions, see Submissions.

List forms

This command lists every form in the workspace, oldest first by default; pass --order desc for newest first. Use this when you want a form’s id, or use --status to narrow the list to active, archived, or favorite forms and --search to find a form by the words in its title.
Sample output (--json)
--status accepts only active, archived, or favorite. Anything else is rejected before a request is made. --order accepts only asc or desc. --search keeps forms whose title contains every word, case-insensitive, and includes archived forms unless --status narrows the list. The id in each record is the form id every other command and endpoint takes. See Getting the Form ID for the other ways to find it.

Show a form

This command shows one form with its questions, in form order. Use this when you want to know what a form asks, or to take the column list for exporting its submissions.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list
Sample output (--json)

Create a form

This command creates a blank form. The new form is an unpublished draft. Use --created-by-email to set the owner; without it, the form belongs to the signed-in user.
--style accepts only single_page or one_question_at_a_time. Anything else is rejected before a request is made.

Update a form

This command renames a form. The title is the only value you can change here. To change questions, see Questions.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Delete a form

This command moves one form to the trash. You can restore it from the trash in the app. The command runs at once and does not ask you to confirm.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Delete many forms

This command moves several forms to the trash in one call. The call is all or nothing: if one id is unknown or not allowed, no form is deleted.
Required arguments:
  • <form-id>... - One or more form UUIDs

Archive, unarchive, enable, disable, favorite, and unfavorite forms

Each of these six commands changes the state of one or more forms and prints the updated forms. Every call is all or nothing: if one id is unknown or not allowed, no form changes.
Required arguments:
  • <form-id>... - One or more form UUIDs
enable and disable replace any submission deadline or limit set on the form.

Clone a form

This command copies a form as Clone of followed by the title. The copy keeps the published questions, theme, conditional logic, and thank-you page. It has no submissions, and it is an unpublished draft.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Publish a form

This command publishes the draft of a form, so people can see your latest changes. If a question has errors, nothing is published and the errors are printed.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Reset a form

This command throws away the draft changes of a form and goes back to the published version. The draft changes are lost and cannot be restored.
Required arguments:
  • <form-id> - The form’s UUID, from neetoform forms list

Count forms

This command counts the forms you can see, as total, active, archived, and favorite forms. Favorite forms do not include archived ones.
Sample output (--json)

Transfer forms

This command moves forms to another workspace. It needs a signed-in CLI session, so it does not work with an API key, and you must be an admin of the destination workspace. After the move, integrations are disconnected, the forms get new public links, and the forms are disabled. Old links to the forms stop working.
Required arguments:
  • <form-id>... - One or more form UUIDs

List submissions for a form

See Submissions.