Typeform tools
The 9 Typeform operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List workspacesGETLists the workspaces the account can reach, across its organizations, with id, name, self.href and the number of forms. Paginate with page until it reaches the page_count of the response.
- Create workspacePOSTCreates a workspace in the organization where the connected user is an owner, and returns it with id and self.href.
- List formsGETLists the forms of the account, public and private, with id, title, dates and the public link in _links.display. Paginate with page until it reaches the page_count of the response.
- Get formGETReturns the whole definition of a form: settings, theme, workspace, hidden fields, screens, logic and the fields with their ids and refs. The field ids are what the response tools filter on.
- Create formPOSTCreates a form in a workspace and returns it with its id, field ids and the public link in _links.display. Images in fields and screens must already exist in the account.
- Update formPUTReplaces the whole definition of a form. Read it with Get form, change what you need and send everything back: every field keeps its id, and a field left out is deleted together with its answers in the existing responses.
- List responsesGETLists the responses of a form, newest first, with answers, hidden fields, variables, metadata and the landed_at and submitted_at times. Responses from the last 30 minutes may be missing. The body brings total_items; for the next page, pass the response_id of the last item as before.
- Search responsesPOSTSearches the responses of a form by answer values, tags, hidden fields, metadata or submission time, all conditions together. Use it over List responses to filter by an answer. For the next page, pass the response_id of the last item as before_response_id.
- List themesGETLists the themes of the account, newest first, with id, name, colors and font. Paginate with page until it reaches the page_count of the response.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
