typeform

# Typeform Access the Typeform API with managed OAuth authentication. Create and manage forms, retrieve responses, and access insights. ## Quick Start ```bash # List forms python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/typeform/forms?page_size=10') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ## Base URL ``` https://gateway.maton.ai/typeform/{native-api-path} ``` Replace `{native-api-path}` with the actual Typeform API endpoint path. The gateway proxies requests to `api.typeform.com` and automatically injects your OAuth token. ## Authentication All requests require the Maton API key in the Authorization header: ``` Authorization: Bearer $MATON_API_KEY ``` **Environment Variable:** Set your API key as `MATON_API_KEY`: ```bash export MATON_API_KEY="YOUR_API_KEY" ``` ### Getting Your API Key 1. Sign in or create an account at [maton.ai](https://maton.ai) 2. Go to [maton.ai/settings](https://maton.ai/settings) 3. Copy your API key ## Connection Management Manage your Typeform OAuth connections at `https://ctrl.maton.ai`. ### List Connections ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections?app=typeform&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Create Connection ```bash python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'typeform'}).encode() req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Get Connection ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` **Response:** ```json { "connection": { "connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80", "status": "ACTIVE", "creation_time": "2025-12-08T07:20:53.488460Z", "last_updated_time": "2026-01-31T20:03:32.593153Z", "url": "https://connect.maton.ai/?session_token=...", "app": "typeform", "metadata": {} } } ``` Open the returned `url` in a browser to complete OAuth authorization. ### Delete Connection ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Specifying Connection If you have multiple Typeform connections, specify which one to use with the `Maton-Connection` header: ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/typeform/forms?page_size=10') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` If omitted, the gateway uses the default (oldest) active connection. ## API Reference ### User ```bash GET /typeform/me ``` ### Forms #### List Forms ```bash GET /typeform/forms?page_size=10 ``` #### Get Form ```bash GET /typeform/forms/{formId} ``` #### Create Form ```bash POST /typeform/forms Content-Type: application/json { "title": "Customer Survey", "fields": [ {"type": "short_text", "title": "What is your name?"}, {"type": "email", "title": "What is your email?"} ] } ``` #### Update Form ```bash PUT /typeform/forms/{formId} Content-Type: application/json { "title": "Updated Survey Title", "fields": [...] } ``` #### Delete Form ```bash DELETE /typeform/forms/{formId} ``` ### Responses #### List Responses ```bash GET /typeform/forms/{formId}/responses?page_size=25 ``` With filters: ```bash GET /typeform/forms/{formId}/responses?since=2024-01-01T00:00:00Z&until=2024-12-31T23:59:59Z&completed=true ``` ### Insights ```bash GET /typeform/insights/{formId}/summary ``` ### Workspaces ```bash GET /typeform/workspaces GET /typeform/workspaces/{workspaceId} ``` ## Field Types - `short_text` - Single line text - `long_text` - Multi-line text - `email` - Email address - `number` - Numeric input - `rating` - Star rating - `opinion_scale` - 0-10 scale - `multiple_choice` - Single or multiple selection - `yes_no` - Boolean - `date` - Date picker - `dropdown` - Dropdown selection ## Code Examples ### JavaScript ```javascript const response = await fetch( 'https://gateway.maton.ai/typeform/forms?page_size=10', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ); ``` ### Python ```python import os import requests response = requests.get( "https://gateway.maton.ai/typeform/forms", headers={"Authorization": f"Bearer {os.environ['MATON_API_KEY']}"}, params={"page_size": 10}, ) ``` ## Notes - Form IDs are alphanumeric strings - Response pagination uses `before` token - Timestamps are in ISO 8601 format - DELETE operations return HTTP 204 - IMPORTANT: When using curl commands, use `curl -g` when URLs contain brackets (`fields[]`, `sort[]`, `records[]`) to disable glob parsing - IMPORTANT: When piping curl output to `jq` or other commands, environment variables like `$MATON_API_KEY` may not expand correctly in some shell environments. You may get "Invalid API key" errors when piping. ## Error Handling | Status | Meaning | |--------|---------| | 400 | Missing Typeform connection | | 401 | Invalid or missing Maton API key | | 429 | Rate limited (10 req/sec per account) | | 4xx/5xx | Passthrough error from Typeform API | ### Troubleshooting: API Key Issues 1. Check that the `MATON_API_KEY` environment variable is set: ```bash echo $MATON_API_KEY ``` 2. Verify the API key is valid by listing connections: ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Troubleshooting: Invalid App Name 1. Ensure your URL path starts with `typeform`. For example: - Correct: `https://gateway.maton.ai/typeform/forms` - Incorrect: `https://gateway.maton.ai/forms` ## Resources - [Typeform API Overview](https://www.typeform.com/developers/get-started) - [Forms](https://www.typeform.com/developers/create/reference/retrieve-forms) - [Responses](https://www.typeform.com/developers/responses/reference/retrieve-responses) - [Workspaces](https://www.typeform.com/developers/create/reference/retrieve-workspaces) - [Maton Community](https://discord.com/invite/dBfFAcefs2) - [Maton Support](mailto:support@maton.ai)