Package: typeform
typeformPython Client wrapper forTypeform APITable of contentsInstallationUsageInitializeReferenceCreate ClientFormsResponsesInstallationpipinstalltypeformUsageInitialize1 - Import client libraryfromtypeformimportTypeform2 - Create an instance with your personal tokentypeform=Typeform('<api_key>')3 - Use any of the methods available in thereference# will retrieve all formsforms:dict=typeform.forms.list()ReferenceTypeform('<api_key>')Creates a new instance of Typeform's Python clientReturns an instance with the methods described belowtypeform=Typeform('<api_key>')Client returns the following properties:formsresponsesEach one of them encapsulates the operations related to it (like listing, updating, deleting the resource).Formsforms.create(data: dict = {})Creates a form. Returnsdictof created form.See docs.forms=Typeform('<api_key>').formsresult:dict=forms.create({'title':'Hello World'})forms.delete(uid: str)Deletes the form with the given form_id and all of the form's responses. Returns astrbased on success of deletion,OKon success, otherwise an error message.See docs.forms=Typeform('<api_key>').formsresult:str=forms.delete('abc123')forms.get(uid: str)Retrieves a form by the given form_id. Includes any theme and images attached to the form as references.See docs.forms=Typeform('<api_key>').formsresult:dict=forms.get('abc123')forms.list(page: int = None, pageSize: int = None, search: str = None, workspaceId: str = None)Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private). Forms are listed in reverse-chronological order based on the last date they were modified.See docs.forms=Typeform('<api_key>').formsresult:dict=forms.list()forms.update(uid: str, patch: bool = False, data: dict = {})Updates an existing form. Defaults toput.putwill return the modified form as adictobject.patchwill Returns astrbased on success of change,OKon success, otherwise an error message.Seeputdocsorpatchdocs.forms=Typeform('<api_key>').formsresult:dict=forms.update('abc123',{'title':'Hello World, Again'})result:str=forms.update('abc123',{'title':'Hello World, Again'},patch=True)forms.messages.get(uid: str)Retrieves the customizable messages for a form (specified by form_id) using the form's specified language. You can format messages with bold (bold) and italic (italic) text. HTML tags are forbidden.See docs.forms=Typeform('<api_key>').formsresult:dict=forms.messages.get('abc123')forms.messages.update(uid: str, data={})Specifies new values for the customizable messages in a form (specified by form_id). You can format messages with bold (bold) and italic (italic) text. HTML tags are forbidden. Returns astrbased on success of change,OKon success, otherwise an error message.See docs.forms=Typeform('<api_key>').formsresult:str=forms.messages.update('abc123',{'label.buttonHint.default':'New Button Hint'})Responsesresponses.list(uid: str, pageSize: int = None, since: str = None, until: str = None, after: str = None, before: str = None, includedResponseIds: str = None, completed: bool = None, sort: str = None, query: str = None, fields: List[str] = None)Returns form responses and date and time of form landing and submission.See docs.responses=Typeform('<api_key>').responsesresult:dict=responses.list('abc123')responses.delete(uid: str, includedTokens: Union[str, List[str]])Delete responses to a form. You must specify theincluded_tokensparameter. Returns astrbased on success of deletion,OKon success, otherwise an error message.See docs.responses=Typeform('<api_key>').responsesresult:str=responses.delete('abc123''token1')result:str=responses.delete('abc123'['token2','token3'])