Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /typeform | Type: Application | PCID required: Yes
Create a form
Parameters:
Parameter Type Required Default Description fieldsobject[] No — Array of form fields/questions hiddenstring[] No — Hidden fields to include in the form URL settingsobject No — Form settings thankyou_screensobject[] No — Thank you screen configurations themeobject No — Theme to apply to the form titlestring Yes — Title of the form typestring No — Form type welcome_screensobject[] No — Welcome screen configurations workspaceobject No — Workspace to create the form in
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"fields" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Array of form fields/questions"
},
"hidden" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Hidden fields to include in the form URL"
},
"settings" : {
"type" : "object" ,
"description" : "Form settings" ,
"properties" : {
"language" : {
"type" : "string" ,
"description" : "Language code (default en)"
},
"is_public" : {
"type" : "boolean" ,
"description" : "Whether the form is publicly accessible"
},
"progress_bar" : {
"type" : "string" ,
"description" : "Progress bar display type"
},
"show_progress_bar" : {
"type" : "boolean" ,
"description" : "Show Progress Bar"
},
"meta" : {
"type" : "object" ,
"description" : "The meta value"
}
}
},
"thankyou_screens" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Thank you screen configurations"
},
"theme" : {
"type" : "object" ,
"description" : "Theme to apply to the form" ,
"properties" : {
"href" : {
"type" : "string" ,
"description" : "Theme URL (e.g. https://api.typeform.com/themes/{theme_id})"
}
}
},
"title" : {
"type" : "string" ,
"description" : "Title of the form"
},
"type" : {
"type" : "string" ,
"description" : "Form type" ,
"enum" : [
"quiz" ,
"classification" ,
"score" ,
"branching" ,
"classification_branching" ,
"score_branching"
]
},
"welcome_screens" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Welcome screen configurations"
},
"workspace" : {
"type" : "object" ,
"description" : "Workspace to create the form in" ,
"properties" : {
"href" : {
"type" : "string" ,
"description" : "Workspace URL (e.g. https://api.typeform.com/workspaces/{workspace_id})"
}
}
}
},
"required" : [
"PCID" ,
"title"
]
}
Create or update a webhook
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form tagstring Yes — Unique name/tag for the webhook enabledboolean Yes — Whether the webhook should send responses immediately event_typesobject No — Event types to subscribe to (e.g. form_response, form_response_partial) secretstring No — Secret key for HMAC SHA256 payload signing urlstring Yes — URL to send webhook payloads to verify_sslboolean No — Whether to verify SSL certificates on the webhook URL
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"tag" : {
"type" : "string" ,
"description" : "Unique name/tag for the webhook"
},
"enabled" : {
"type" : "boolean" ,
"description" : "Whether the webhook should send responses immediately"
},
"event_types" : {
"type" : "object" ,
"description" : "Event types to subscribe to (e.g. form_response, form_response_partial)"
},
"secret" : {
"type" : "string" ,
"description" : "Secret key for HMAC SHA256 payload signing"
},
"url" : {
"type" : "string" ,
"description" : "URL to send webhook payloads to"
},
"verify_ssl" : {
"type" : "boolean" ,
"description" : "Whether to verify SSL certificates on the webhook URL"
}
},
"required" : [
"PCID" ,
"form_id" ,
"tag" ,
"enabled" ,
"url"
]
}
Delete a form
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
Delete form responses
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form included_response_idsstring Yes — Comma-separated list of response IDs to delete (up to 1000)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"included_response_ids" : {
"type" : "string" ,
"description" : "Comma-separated list of response IDs to delete (up to 1000)"
}
},
"required" : [
"PCID" ,
"form_id" ,
"included_response_ids"
]
}
Delete a webhook
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form tagstring Yes — Unique name/tag of the webhook to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"tag" : {
"type" : "string" ,
"description" : "Unique name/tag of the webhook to delete"
}
},
"required" : [
"PCID" ,
"form_id" ,
"tag"
]
}
Retrieve a form
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form (found in the form URL)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form (found in the form URL)"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
Retrieve a theme
Parameters:
Parameter Type Required Default Description theme_idstring Yes — Unique ID for the theme
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"theme_id" : {
"type" : "string" ,
"description" : "Unique ID for the theme"
}
},
"required" : [
"PCID" ,
"theme_id"
]
}
Retrieve a webhook
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form tagstring Yes — Unique name/tag of the webhook
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"tag" : {
"type" : "string" ,
"description" : "Unique name/tag of the webhook"
}
},
"required" : [
"PCID" ,
"form_id" ,
"tag"
]
}
List forms
Parameters:
Parameter Type Required Default Description searchstring No — Filter results to forms containing this string in the title pageinteger No — Page number to retrieve (default 1) page_sizeinteger No — Number of results per page (default 10, max 200) workspace_idstring No — Filter forms by workspace ID sort_bystring No — Field to sort by order_bystring No — Sort order
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"search" : {
"type" : "string" ,
"description" : "Filter results to forms containing this string in the title"
},
"page" : {
"type" : "integer" ,
"description" : "Page number to retrieve (default 1)"
},
"page_size" : {
"type" : "integer" ,
"description" : "Number of results per page (default 10, max 200)"
},
"workspace_id" : {
"type" : "string" ,
"description" : "Filter forms by workspace ID"
},
"sort_by" : {
"type" : "string" ,
"description" : "Field to sort by" ,
"enum" : [
"created_at" ,
"last_updated_at"
]
},
"order_by" : {
"type" : "string" ,
"description" : "Sort order" ,
"enum" : [
"asc" ,
"desc"
]
}
},
"required" : [
"PCID"
]
}
List form responses
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form page_sizeinteger No — Maximum number of responses to retrieve (default 25, max 1000) sincestring No — Filter responses submitted after this date (ISO 8601 or Unix timestamp) untilstring No — Filter responses submitted before this date (ISO 8601 or Unix timestamp) afterstring No — Pagination cursor — retrieve responses after this token (mutually exclusive with sort) beforestring No — Pagination cursor — retrieve responses before this token (mutually exclusive with sort) included_response_idsstring No — Comma-separated list of response IDs to include excluded_response_idsstring No — Comma-separated list of response IDs to exclude response_typestring No — Filter by response type: started, partial, or completed sortstring No — Sort responses in format: {fieldID},{asc|desc} querystring No — Search string to filter across all answers and fields fieldsstring No — Comma-separated field IDs — only show answers for these fields answered_fieldsstring No — Comma-separated field IDs — only return responses that answered these fields
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"page_size" : {
"type" : "integer" ,
"description" : "Maximum number of responses to retrieve (default 25, max 1000)"
},
"since" : {
"type" : "string" ,
"description" : "Filter responses submitted after this date (ISO 8601 or Unix timestamp)"
},
"until" : {
"type" : "string" ,
"description" : "Filter responses submitted before this date (ISO 8601 or Unix timestamp)"
},
"after" : {
"type" : "string" ,
"description" : "Pagination cursor — retrieve responses after this token (mutually exclusive with sort)"
},
"before" : {
"type" : "string" ,
"description" : "Pagination cursor — retrieve responses before this token (mutually exclusive with sort)"
},
"included_response_ids" : {
"type" : "string" ,
"description" : "Comma-separated list of response IDs to include"
},
"excluded_response_ids" : {
"type" : "string" ,
"description" : "Comma-separated list of response IDs to exclude"
},
"response_type" : {
"type" : "string" ,
"description" : "Filter by response type: started, partial, or completed" ,
"enum" : [
"started" ,
"partial" ,
"completed"
]
},
"sort" : {
"type" : "string" ,
"description" : "Sort responses in format: {fieldID},{asc|desc}"
},
"query" : {
"type" : "string" ,
"description" : "Search string to filter across all answers and fields"
},
"fields" : {
"type" : "string" ,
"description" : "Comma-separated field IDs — only show answers for these fields"
},
"answered_fields" : {
"type" : "string" ,
"description" : "Comma-separated field IDs — only return responses that answered these fields"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
List themes
Parameters:
Parameter Type Required Default Description pageinteger No — Page number to retrieve (default 1) page_sizeinteger No — Number of results per page (default 10, max 200)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"page" : {
"type" : "integer" ,
"description" : "Page number to retrieve (default 1)"
},
"page_size" : {
"type" : "integer" ,
"description" : "Number of results per page (default 10, max 200)"
}
},
"required" : [
"PCID"
]
}
List webhooks for a form
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
}
},
"required" : [
"PCID" ,
"form_id"
]
}
List workspaces
Parameters:
Parameter Type Required Default Description searchstring No — Filter workspaces containing this string pageinteger No — Page number to retrieve (default 1) page_sizeinteger No — Number of results per page (default 10, max 200)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"search" : {
"type" : "string" ,
"description" : "Filter workspaces containing this string"
},
"page" : {
"type" : "integer" ,
"description" : "Page number to retrieve (default 1)"
},
"page_size" : {
"type" : "integer" ,
"description" : "Number of results per page (default 10, max 200)"
}
},
"required" : [
"PCID"
]
}
Update a form (partial)
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form bodyobject[] Yes — Array of JSON Patch operations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Array of JSON Patch operations"
}
},
"required" : [
"PCID" ,
"form_id" ,
"body"
]
}
Update a form (full replace)
Parameters:
Parameter Type Required Default Description form_idstring Yes — Unique ID for the form fieldsobject[] Yes — All fields for the form (include existing field IDs to preserve them) hiddenstring[] No — The hidden value logicobject[] No — The logic value settingsobject No — The settings value thankyou_screensobject[] No — Thankyou Screens themeobject No — The theme value titlestring Yes — Title of the form typestring No — Form type welcome_screensobject[] No — Welcome Screens workspaceobject No — The workspace value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"form_id" : {
"type" : "string" ,
"description" : "Unique ID for the form"
},
"fields" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "All fields for the form (include existing field IDs to preserve them)"
},
"hidden" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "The hidden value"
},
"logic" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The logic value"
},
"settings" : {
"type" : "object" ,
"description" : "The settings value"
},
"thankyou_screens" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Thankyou Screens"
},
"theme" : {
"type" : "object" ,
"description" : "The theme value" ,
"properties" : {
"href" : {
"type" : "string" ,
"description" : "The href value"
}
}
},
"title" : {
"type" : "string" ,
"description" : "Title of the form"
},
"type" : {
"type" : "string" ,
"description" : "Form type"
},
"welcome_screens" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Welcome Screens"
},
"workspace" : {
"type" : "object" ,
"description" : "The workspace value" ,
"properties" : {
"href" : {
"type" : "string" ,
"description" : "The href value"
}
}
}
},
"required" : [
"PCID" ,
"form_id" ,
"fields" ,
"title"
]
}