Typeform Component
Typeform is an online form builder that enables users to create interactive and engaging surveys, forms, and quizzes.
Component key: typeformDescription
Typeform is an online form builder that enables users to create interactive and engaging surveys, forms, and quizzes.
Use the component to deploy forms and manage the responses in real time.
API Documentation
The component was built using the Typeform API References
Connections
OAuth 2.0
To Generate an OAuth App:
- Log in to your account at Typeform.
- In the upper-left corner, click icon drop-down menu next to your organization name.
- Under Organization section, click Developer Apps.
- Click Register a new app.
- In the App Name field, type the name for your new app.
- In the App website field, type the complete URL for your app's homepage.
- In the Redirect URI(s) field, enter https://oauth2.prismatic.io/callback for US based integrations
- For integrations outside the US refer to this guide to find your region’s Callback URL
- Click Register app.
- Enter the following into the connection configuration of your integration
- Scopes (Recommended):
offline accounts:read forms:write forms:read images:write images:write images:read themes:write themes:read responses:read responses:write webhooks:read webhooks:write workspaces:read workspaces:write - Client ID
- Client Secret
- Scopes (Recommended):
Personal Token
To Generate a Personal Access Token:
- Log in to your account at Typeform.
- In the upper-left corner, in the drop-down menu next to your username, click Account.
- In the left menu, click Personal tokens or here.
- Click Generate a new token.
- In the Token name field, type a name for the token to help you identify it.
- Choose needed scopes (API actions this token can perform - or permissions it has). See here for more details on scopes.
- Click Generate token.
- Enter the token value into the Personal Token field of the connection in your integration.
Triggers
Typeform Webhook Trigger
Get notified when a project is created, updated, or deleted in a workspace. | key: formTrigger
Data Sources
Select Account Workspaces
Allow a user to select one of their account workspaces | key: selectAccountWorkspaces | type: picklist
Data Source Payload
{
"result": [
{
"label": "My Workspace",
"key": "a1b2c3"
},
{
"label": "My Second Workspace",
"key": "a1b2c323"
}
]
}
Select Form
Allow a user to select one of their forms | key: selectForm | type: picklist
Data Source Payload
{
"result": [
{
"label": "Form title",
"key": "PVdw1syM"
},
{
"label": "My Other Form",
"key": "PVdw1syMS"
}
]
}
Select Workspaces
Allow a user to select one of their workspaces | key: selectWorkspaces | type: picklist
Data Source Payload
{
"result": [
{
"label": "My Workspace",
"key": "a1b2c3"
},
{
"label": "My Second Workspace",
"key": "a1b2c323"
}
]
}
Actions
Create Account Workspace
Create a workspace in a specific account. | key: createAccountWorkspace
Output Example Payload
{
"data": {
"account_id": "ABCD1234",
"forms": [
{
"count": 12,
"href": "https://api.typeform.com/workspaces/a1b2c3/forms"
}
],
"id": "a1b2c3",
"name": "My Workspace",
"self": [
{
"href": "https://api.typeform.com/workspaces/a1b2c3"
}
],
"shared": false
}
}
Create Form
Create a form | key: createForm
Output Example Payload
{
"data": {
"id": "id",
"title": "title",
"language": "en",
"fields": [
{}
],
"hidden": [
"string"
],
"variables": {
"score": 0,
"price": 0
},
"welcome_screens": [
{
"ref": "nice-readable-welcome-ref",
"title": "Welcome Title",
"properties": {
"description": "Cool description for the welcome",
"show_button": true,
"button_text": "start"
},
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"layout": {
"type": "float",
"placement": "left",
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"viewport_overrides": {
"small": {
"type": "float",
"placement": "left"
},
"large": {
"type": "split",
"placement": "right"
}
}
}
}
],
"thankyou_screens": [
{
"ref": "nice-readable-thank-you-ref",
"title": "Thank you Title",
"type": "type",
"properties": {
"show_button": true,
"button_text": "start",
"button_mode": "redirect",
"redirect_url": "https://www.typeform.com",
"share_icons": true
},
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"layout": {
"type": "float",
"placement": "left",
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"viewport_overrides": {
"small": {
"type": "float",
"placement": "left"
},
"large": {
"type": "split",
"placement": "right"
}
}
}
}
],
"logic": [
{
"type": "type",
"ref": "ref",
"actions": [
{
"action": "action",
"details": {
"to": {
"type": "type",
"value": "value"
},
"target": {
"type": "type",
"value": "value"
},
"value": {
"type": "type"
}
},
"condition": {
"op": "op",
"vars": [
{
"type": "type",
"value": {}
}
]
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/Fs24as"
},
"workspace": {
"href": "https://api.typeform.com/workspaces/Aw33bz"
},
"_links": {
"display": "https://subdomain.typeform.com/to/abc123"
},
"settings": {
"language": "language",
"is_public": true,
"autosave_progress": true,
"progress_bar": "proportion",
"show_progress_bar": true,
"show_typeform_branding": true,
"show_time_to_complete": true,
"show_number_of_submissions": true,
"show_cookie_consent": true,
"show_question_number": true,
"show_key_hint_on_choices": true,
"hide_navigation": true,
"meta": {
"title": "title",
"allow_indexing": true,
"description": "description",
"image": {
"href": "href"
}
},
"redirect_after_submit_url": "redirect_after_submit_url",
"google_analytics": "google_analytics",
"facebook_pixel": "facebook_pixel",
"google_tag_manager": "google_tag_manager",
"milestones": [
{
"field_ref": "field_ref",
"status": "status",
"reason": "reason"
}
],
"enrichment_in_renderer": {
"toggle": true,
"active": true
}
},
"cui_settings": {
"avatar": "https://images.typeform.com/images/4bcd3",
"is_typing_emulation_disabled": true,
"typing_emulation_speed": "fast"
}
}
}
Create or Update Webhook
Create or Update a Webhook | key: createWebhook
Output Example Payload
{
"data": {
"created_at": "2016-11-21T12:23:28.000Z",
"enabled": true,
"event_types": {
"form_response": true,
"form_response_partial": true
},
"form_id": "abc123",
"id": "yRtagDm8AT",
"tag": "phoenix",
"updated_at": "2016-11-21T12:23:28.000Z",
"url": "https://test.com",
"verify_ssl": true
}
}
Create Workspace
Create a workspace. | key: createWorkspace
Output Example Payload
{
"data": {
"account_id": "ABCD1234",
"forms": [
{
"count": 12,
"href": "https://api.typeform.com/workspaces/a1b2c3/forms"
}
],
"id": "a1b2c3",
"name": "My Workspace",
"self": [
{
"href": "https://api.typeform.com/workspaces/a1b2c3"
}
],
"shared": false
}
}
Delete Form
Delete a form. | key: deleteForm
Output Example Payload
{
"data": {
"message": "Deleted successfully"
}
}
Delete Instance Webhooks
Delete all webhooks from a form for the instance url provided. | key: deleteAllInstanceWebhooks
Output Example Payload
{
"data": "Deleted successfully"
}
Delete Response
Delete responses to a form. | key: deleteResponses
Output Example Payload
{
"data": {
"message": "Deleted successfully"
}
}
Delete Webhook
Delete a webhook. | key: deleteWebhook
Output Example Payload
{
"data": {
"message": "Deleted successfully"
}
}
Delete Workspace
Delete a workspace. | key: deleteWorkspace
Output Example Payload
{
"data": {
"message": "Deleted successfully"
}
}
Get All Response Files
Download a zip archive containing all files uploaded by respondents for the specified form ID. | key: getAllResponseFiles
Output Example Payload
{
"data": {
"type": "Buffer",
"data": [
102,
105,
108,
101,
32,
99,
111,
110,
116,
101,
110,
116
]
}
}
Get File from Response
Download an uploaded file knowing its form, response, field and name. | key: getFileFromResponse
Output Example Payload
{
"data": {
"type": "Buffer",
"data": [
102,
105,
108,
101,
32,
99,
111,
110,
116,
101,
110,
116
]
}
}
Get Form
Retrieve a form. | key: getForm
Output Example Payload
{
"data": {
"id": "id",
"title": "title",
"language": "en",
"fields": [
{}
],
"hidden": [
"string"
],
"variables": {
"score": 0,
"price": 0
},
"welcome_screens": [
{
"ref": "nice-readable-welcome-ref",
"title": "Welcome Title",
"properties": {
"description": "Cool description for the welcome",
"show_button": true,
"button_text": "start"
},
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"layout": {
"type": "float",
"placement": "left",
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"viewport_overrides": {
"small": {
"type": "float",
"placement": "left"
},
"large": {
"type": "split",
"placement": "right"
}
}
}
}
],
"thankyou_screens": [
{
"ref": "nice-readable-thank-you-ref",
"title": "Thank you Title",
"type": "type",
"properties": {
"show_button": true,
"button_text": "start",
"button_mode": "redirect",
"redirect_url": "https://www.typeform.com",
"share_icons": true
},
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"layout": {
"type": "float",
"placement": "left",
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"viewport_overrides": {
"small": {
"type": "float",
"placement": "left"
},
"large": {
"type": "split",
"placement": "right"
}
}
}
}
],
"logic": [
{
"type": "type",
"ref": "ref",
"actions": [
{
"action": "action",
"details": {
"to": {
"type": "type",
"value": "value"
},
"target": {
"type": "type",
"value": "value"
},
"value": {
"type": "type"
}
},
"condition": {
"op": "op",
"vars": [
{
"type": "type",
"value": {}
}
]
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/Fs24as"
},
"workspace": {
"href": "https://api.typeform.com/workspaces/Aw33bz"
},
"_links": {
"display": "https://subdomain.typeform.com/to/abc123"
},
"settings": {
"language": "language",
"is_public": true,
"autosave_progress": true,
"progress_bar": "proportion",
"show_progress_bar": true,
"show_typeform_branding": true,
"show_time_to_complete": true,
"show_number_of_submissions": true,
"show_cookie_consent": true,
"show_question_number": true,
"show_key_hint_on_choices": true,
"hide_navigation": true,
"meta": {
"title": "title",
"allow_indexing": true,
"description": "description",
"image": {
"href": "href"
}
},
"redirect_after_submit_url": "redirect_after_submit_url",
"google_analytics": "google_analytics",
"facebook_pixel": "facebook_pixel",
"google_tag_manager": "google_tag_manager",
"milestones": [
{
"field_ref": "field_ref",
"status": "status",
"reason": "reason"
}
],
"enrichment_in_renderer": {
"toggle": true,
"active": true
}
},
"cui_settings": {
"avatar": "https://images.typeform.com/images/4bcd3",
"is_typing_emulation_disabled": true,
"typing_emulation_speed": "fast"
}
}
}
Get Webhook
Retrieve a single webhook. | key: getWebhook
Output Example Payload
{
"data": {
"created_at": "2016-11-21T12:23:28.000Z",
"enabled": true,
"event_types": {
"form_response": true,
"form_response_partial": true
},
"form_id": "abc123",
"id": "yRtagDm8AT",
"tag": "phoenix",
"updated_at": "2016-11-21T12:23:28.000Z",
"url": "https://test.com",
"verify_ssl": true
}
}
Get Workspace
Retrieve a workspace. | key: getWorkspace
Output Example Payload
{
"data": {
"account_id": "ABCD1234",
"forms": [
{
"count": 12,
"href": "https://api.typeform.com/workspaces/a1b2c3/forms"
}
],
"id": "a1b2c3",
"name": "My Workspace",
"self": [
{
"href": "https://api.typeform.com/workspaces/a1b2c3"
}
],
"shared": false
}
}
List Account Workspaces
Retrieve all workspaces you have access to within the specific account. | key: listAccountWorkspaces
Output Example Payload
{
"data": {
"items": [
{
"account_id": "ABCD1234",
"forms": [
{
"count": 12,
"href": "https://api.typeform.com/workspaces/a1b2c3/forms"
}
],
"id": "a1b2c3",
"name": "My Workspace",
"self": [
{
"href": "https://api.typeform.com/workspaces/a1b2c3"
}
],
"shared": false
}
],
"page_count": 1,
"total_items": 10
}
}
List Forms
Retrieves a list of JSON descriptions for all forms in your Typeform account (public and private). | key: listForms
Output Example Payload
{
"data": {
"items": [
{
"id": "id",
"title": "title",
"language": "en",
"fields": [
{}
],
"hidden": [
"string"
],
"variables": {
"score": 0,
"price": 0
},
"welcome_screens": [
{
"ref": "nice-readable-welcome-ref",
"title": "Welcome Title",
"properties": {
"description": "Cool description for the welcome",
"show_button": true,
"button_text": "start"
},
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"layout": {
"type": "float",
"placement": "left",
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"viewport_overrides": {
"small": {
"type": "float",
"placement": "left"
},
"large": {
"type": "split",
"placement": "right"
}
}
}
}
],
"thankyou_screens": [
{
"ref": "nice-readable-thank-you-ref",
"title": "Thank you Title",
"type": "type",
"properties": {
"show_button": true,
"button_text": "start",
"button_mode": "redirect",
"redirect_url": "https://www.typeform.com",
"share_icons": true
},
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"layout": {
"type": "float",
"placement": "left",
"attachment": {
"type": "image",
"href": {
"image": {
"value": "https://images.typeform.com/images/4bcd3"
},
"Pexels": {
"value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
},
"Vimeo": {
"value": "https://vimeo.com/245714980"
},
"YouTube": {
"value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
}
},
"scale": 0,
"properties": {
"description": "description"
}
},
"viewport_overrides": {
"small": {
"type": "float",
"placement": "left"
},
"large": {
"type": "split",
"placement": "right"
}
}
}
}
],
"logic": [
{
"type": "type",
"ref": "ref",
"actions": [
{
"action": "action",
"details": {
"to": {
"type": "type",
"value": "value"
},
"target": {
"type": "type",
"value": "value"
},
"value": {
"type": "type"
}
},
"condition": {
"op": "op",
"vars": [
{
"type": "type",
"value": {}
}
]
}
}
]
}
],
"theme": {
"href": "https://api.typeform.com/themes/Fs24as"
},
"workspace": {
"href": "https://api.typeform.com/workspaces/Aw33bz"
},
"_links": {
"display": "https://subdomain.typeform.com/to/abc123"
},
"settings": {
"language": "language",
"is_public": true,
"autosave_progress": true,
"progress_bar": "proportion",
"show_progress_bar": true,
"show_typeform_branding": true,
"show_time_to_complete": true,
"show_number_of_submissions": true,
"show_cookie_consent": true,
"show_question_number": true,
"show_key_hint_on_choices": true,
"hide_navigation": true,
"meta": {
"title": "title",
"allow_indexing": true,
"description": "description",
"image": {
"href": "href"
}
},
"redirect_after_submit_url": "redirect_after_submit_url",
"google_analytics": "google_analytics",
"facebook_pixel": "facebook_pixel",
"google_tag_manager": "google_tag_manager",
"milestones": [
{
"field_ref": "field_ref",
"status": "status",
"reason": "reason"
}
],
"enrichment_in_renderer": {
"toggle": true,
"active": true
}
},
"cui_settings": {
"avatar": "https://images.typeform.com/images/4bcd3",
"is_typing_emulation_disabled": true,
"typing_emulation_speed": "fast"
}
}
]
}
}
List Responses
Returns form responses and date and time of form landing and submission. | key: listResponses
Output Example Payload
{
"data": {
"items": [
{
"answers": [
{
"field": {
"id": "hVONkQcnSNRj",
"ref": "my_custom_dropdown_reference",
"type": "dropdown"
},
"text": "Job opportunities",
"type": "text"
},
{
"boolean": false,
"field": {
"id": "RUqkXSeXBXSd",
"ref": "my_custom_yes_no_reference",
"type": "yes_no"
},
"type": "boolean"
},
{
"boolean": true,
"field": {
"id": "gFFf3xAkJKsr",
"ref": "my_custom_legal_reference",
"type": "legal"
},
"type": "boolean"
},
{
"field": {
"id": "JwWggjAKtOkA",
"ref": "my_custom_short_text_reference",
"type": "short_text"
},
"text": "Lian",
"type": "text"
},
{
"email": "lian1078@other.com",
"field": {
"id": "SMEUb7VJz92Q",
"ref": "my_custom_email_reference",
"type": "email"
},
"type": "email"
},
{
"field": {
"id": "pn48RmPazVdM",
"ref": "my_custom_number_reference",
"type": "number"
},
"number": 1,
"type": "number"
},
{
"field": {
"id": "Q7M2XAwY04dW",
"ref": "my_custom_number2_reference",
"type": "number"
},
"number": 1,
"type": "number"
},
{
"field": {
"id": "WOTdC00F8A3h",
"ref": "my_custom_rating_reference",
"type": "rating"
},
"number": 3,
"type": "number"
},
{
"field": {
"id": "DlXFaesGBpoF",
"ref": "my_custom_long_text_reference",
"type": "long_text"
},
"text": "It's a big, busy city. I moved here for a job, but I like it, so I am planning to stay. I have made good friends here.",
"type": "text"
},
{
"field": {
"id": "NRsxU591jIW9",
"ref": "my_custom_opinion_scale_reference",
"type": "opinion_scale"
},
"number": 1,
"type": "number"
},
{
"choices": {
"labels": [
"New York",
"Tokyo"
]
},
"field": {
"id": "PNe8ZKBK8C2Q",
"ref": "my_custom_picture_choice_reference",
"type": "picture_choice"
},
"type": "choices"
},
{
"date": "2012-03-20T00:00:00Z",
"field": {
"id": "KoJxDM3c6x8h",
"ref": "my_custom_date_reference",
"type": "date"
},
"type": "date"
},
{
"choice": {
"label": "A friend's experience in Sydney"
},
"field": {
"id": "ceIXxpbP3t2q",
"ref": "my_custom_multiple_choice_reference",
"type": "multiple_choice"
},
"type": "choice"
},
{
"choices": {
"labels": [
"New York",
"Tokyo"
]
},
"field": {
"id": "abISxvbD5t1p",
"ref": "my_custom_ranking_reference",
"type": "ranking"
},
"type": "choices"
},
{
"choice": {
"label": "Tokyo"
},
"field": {
"id": "k6TP9oLGgHjl",
"ref": "my_custom_multiple_choice2_reference",
"type": "multiple_choice"
},
"type": "choice"
}
],
"calculated": {
"score": 2
},
"hidden": {},
"landed_at": "2017-09-14T22:33:59Z",
"landing_id": "21085286190ffad1248d17c4135ee56f",
"metadata": {
"browser": "default",
"network_id": "respondent_network_id",
"platform": "other",
"referer": "https://user_id.typeform.com/to/lR6F4j",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/603.3.8 (KHTML, like Gecko) Version/10.1.2 Safari/603.3.8"
},
"response_id": "21085286190ffad1248d17c4135ee56f",
"submitted_at": "2017-09-14T22:38:22Z",
"token": "test21085286190ffad1248d17c4135ee56f",
"variables": [
{
"key": "score",
"number": 2,
"type": "number"
},
{
"key": "name",
"text": "typeform",
"type": "text"
}
]
}
],
"page_count": 1,
"total_items": 4
}
}
List Webhooks
Retrieve all webhooks for the specified Typeform. | key: listWebhooks
Output Example Payload
{
"data": {
"items": [
{
"created_at": "2016-11-21T12:23:28.000Z",
"enabled": true,
"event_types": {
"form_response": true,
"form_response_partial": true
},
"form_id": "abc123",
"id": "yRtagDm8AT",
"tag": "phoenix",
"updated_at": "2016-11-21T12:23:28.000Z",
"url": "https://test.com",
"verify_ssl": true
}
]
}
}
List Workspaces
Retrieve all workspaces the user has access to. | key: listWorkspaces
Output Example Payload
{
"data": {
"items": [
{
"account_id": "ABCD1234",
"forms": [
{
"count": 12,
"href": "https://api.typeform.com/workspaces/a1b2c3/forms"
}
],
"id": "a1b2c3",
"name": "My Workspace",
"self": [
{
"href": "https://api.typeform.com/workspaces/a1b2c3"
}
],
"shared": false
}
]
}
}
Raw Request
Send raw HTTP request to Typeform API | key: rawRequest
Update Form
Update a form. | key: updateForm
Output Example Payload
{
"data": {
"message": "Operations applied successfully"
}
}
Update Workspace
Update a workspace. | key: updateWorkspace
Output Example Payload
{
"data": {
"message": "Operations applied successfully"
}
}