Repository files navigation

⚠️This library hasn't been maintained for a while so we've decided to deprecate it and archive the repository. Feel free to fork it!

Python Client wrapper forTypeform API

• Installation
• Usage
  • Initialize
• Reference
  • Create Client
  • Forms
  • Responses
  • Themes
  • Images
• Tests

pip install typeform

1 - Import client library

fromtypeformimportTypeform

2 - Create an instance with your personal token

typeform=Typeform('<api_key>')

3 - Use any of the methods available in thereference

# will retrieve all formsforms:dict=typeform.forms.list()

• Creates a new instance of Typeform's Python client
• Returns an instance with the methods described below

typeform=Typeform('<api_key>')

Client returns the following properties:

• forms
• responses

Each one of them encapsulates the operations related to it (like listing, updating, deleting the resource).

Creates a form. Returnsdict of created form.See docs.

forms=Typeform('<api_key>').formsresult:dict=forms.create({'title':'Hello World' })

Deletes the form with the given form_id and all of the form's responses. Returns astr based on success of deletion,OK on success, otherwise an error message.See docs.

forms=Typeform('<api_key>').formsresult:str=forms.delete('abc123')

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')

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()

Updates an existing form. Defaults toput.put will return the modified form as adict object.patch will Returns astr based on success of change,OK on success, otherwise an error message.Seeput docs orpatch docs.

forms=Typeform('<api_key>').formsresult:dict=forms.update('abc123', {'title':'Hello World, Again' })result:str=forms.update('abc123', {'title':'Hello World, Again' },patch=True)

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')

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 astr based on success of change,OK on success, otherwise an error message.See docs.

forms=Typeform('<api_key>').formsresult:str=forms.messages.update('abc123', {'label.buttonHint.default':'New Button Hint'})

Returns form responses and date and time of form landing and submission.See docs.

responses=Typeform('<api_key>').responsesresult:dict=responses.list('abc123')

Delete responses to a form. You must specify theincluded_tokens parameter. Returns astr based on success of deletion,OK on success, otherwise an error message.See docs.

responses=Typeform('<api_key>').responsesresult:str=responses.delete('abc123''token1')result:str=responses.delete('abc123' ['token2','token3'])

Retrieves a theme by the given theme_id.See docs.

themes=Typeform('<api_key>').themesresult:dict=themes.get('abc123')

Retrieves a list of JSON descriptions for all themes in your Typeform account (public and private). Themes are listed in reverse-chronological order based on the date you added them to your account.

themes=Typeform('<api_key>').themesresult:dict=themes.get('abc123')

Retrieves an image by the given id.See docs.

images=Typeform('<api_key>').imagesresult:dict=images.get('abc123')

Retrieves a list of JSON descriptions for all images in your Typeform account. Images are listed in reverse-chronological order based on the date you added them to your account.

images=Typeform('<api_key>').imagesresult:dict=images.list()

Adds an image in your Typeform account.

Specify the URL of your image or send your image in base64 format, which encodes the image data as ASCII text. You can use a tool like Base64 Image Encoder to get the base64 code for the image you want to add.

Check typeform/test/fixtures.py to configure test run.