typeform
Python Client wrapper for Typeform API
Table of contents
Installation
pip install typeform
Usage
Initialize
1 - Import client library
from typeform import Typeform
2 - Create an instance with your personal token
typeform = Typeform('<api_key>')
3 - Use any of the methods available in the reference
# will retrieve all forms
forms: dict = typeform.forms.list()
Reference
Typeform('<api_key>')
- 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:
formsresponses
Each one of them encapsulates the operations related to it (like listing, updating, deleting the resource).
Forms
forms.create(data: dict = {})
Creates a form. Returns dict of created form. See docs.
forms = Typeform('<api_key>').forms
result: 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 a str based on success of deletion, OK on success, otherwise an error message. See docs.
forms = Typeform('<api_key>').forms
result: 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>').forms
result: 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>').forms
result: dict = forms.list()
forms.update(uid: str, patch: bool = False, data: dict = {})
Updates an existing form. Defaults to put. put will return the modified form as a dict object. patch will Returns a str based on success of change, OK on success, otherwise an error message. See put docs or patch docs.
forms = Typeform('<api_key>').forms
result: 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>').forms
result: 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 a str based on success of change, OK on success, otherwise an error message. See docs.
forms = Typeform('<api_key>').forms
result: str = forms.messages.update('abc123', {
'label.buttonHint.default': 'New Button Hint'
})
Responses
responses.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>').responses
result: dict = responses.list('abc123')
responses.delete(uid: str, includedTokens: Union[str, List[str]])
Delete responses to a form. You must specify the included_tokens parameter. Returns a str based on success of deletion, OK on success, otherwise an error message. See docs.
responses = Typeform('<api_key>').responses
result: str = responses.delete('abc123' 'token1')
result: str = responses.delete('abc123' ['token2', 'token3'])
Metadata
Release files for typeform 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| typeform-1.1.0.tar.gz | 8.2 kB | Without provenance | Details for typeform-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| typeform-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for typeform-1.1.0-py3-none-any.whl |
Total release size: 19.4 kB
Release files / typeform-1.1.0.tar.gz
| Download URL | typeform-1.1.0.tar.gz |
|---|---|
| Size | 8.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
15e2a096bc26c667e6f037788c2f59b60d13dee7c2945e7954a833052650cb0e
|
|
BLAKE2b-256 checksum How to use checksums |
efdbe99adb000318abe61fc193ddb984a4fafe34b547b55473fcc3b452141d7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2
|
Release files / typeform-1.1.0-py3-none-any.whl
| Download URL | typeform-1.1.0-py3-none-any.whl |
|---|---|
| Size | 11.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6309e5a232b6ae03a96d9d97c7767830211579d0e86a1b019f335a5b17ae0146
|
|
BLAKE2b-256 checksum How to use checksums |
fd491605bb3bc54ece95cbdd9f2409c9f04e543ca86181e4a0eff58c5605407b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.7.2
|
Security for typeform 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.