{ "service": "getform", "displayName": "Getform", "categories": [ "Productivity", "Marketing" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "fi_your_secret_api_key", "description": "Forminit protected-mode API key sent with the X-API-KEY header. Create it from Account > API Tokens in the Forminit dashboard: https://forminit.com/docs/list-submissions-api/." } ], "homepageUrl": "https://forminit.com", "actions": [ { "id": "getform.list_submissions", "service": "getform", "name": "list_submissions", "description": "List submissions from one protected Forminit form with pagination, keyword search, optional file metadata, and timezone formatting.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "formId": { "type": "string", "minLength": 1, "description": "The Forminit form ID whose submissions should be listed." }, "page": { "type": "integer", "minimum": 1, "description": "The page number to request." }, "size": { "type": "integer", "minimum": 1, "maximum": 100, "description": "The page size to request. Forminit documents a range of 1 to 100." }, "query": { "type": "string", "minLength": 1, "description": "Search keyword used to filter submissions." }, "files": { "type": "boolean", "description": "Whether to include file attachment metadata in the response." }, "timezone": { "type": "string", "minLength": 1, "description": "IANA timezone name used to format returned dates." } }, "additionalProperties": false, "required": [ "formId" ], "description": "Input payload for listing submissions from one Forminit form." }, "outputSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Form ID that owns the returned submissions." }, "apiVersion": { "type": "string", "description": "API version returned by Forminit." }, "submissions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "Unique submission identifier returned by Forminit." }, "submissionDate": { "type": "string", "minLength": 1, "description": "Submission timestamp returned by Forminit." }, "status": { "type": "boolean", "description": "Boolean status flag returned for the submission." }, "submissionStatus": { "type": "string", "description": "Submission lifecycle status, such as open." }, "blocks": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String field value." }, { "type": "number", "description": "Numeric field value." }, { "type": "boolean", "description": "Boolean field value." } ], "description": "Scalar field value accepted by a supported Forminit field block." }, { "type": "array", "items": { "type": "string", "description": "One selected value." }, "description": "Array of selected values." }, { "type": "object", "properties": { "email": { "type": "string", "description": "Submitter email address." }, "firstName": { "type": "string", "description": "Submitter first name." }, "lastName": { "type": "string", "description": "Submitter last name." }, "fullName": { "type": "string", "description": "Submitter full name." }, "phone": { "type": "string", "description": "Submitter phone number." }, "title": { "type": "string", "description": "Submitter title." }, "userId": { "type": "string", "description": "Application-specific submitter identifier." }, "address": { "type": "string", "description": "Submitter street address." }, "city": { "type": "string", "description": "Submitter city." }, "country": { "type": "string", "description": "Submitter country code." }, "company": { "type": "string", "description": "Submitter company." }, "position": { "type": "string", "description": "Submitter position." } }, "additionalProperties": true, "description": "Sender block returned inside a normalized submission blocks object." }, { "type": "object", "properties": { "utmSource": { "type": "string", "description": "Campaign traffic source." }, "utmMedium": { "type": "string", "description": "Marketing medium." }, "utmCampaign": { "type": "string", "description": "Campaign identifier." }, "utmTerm": { "type": "string", "description": "Paid keyword or search term." }, "utmContent": { "type": "string", "description": "Ad or content variant identifier." }, "referrer": { "type": "string", "description": "Previous page URL or referrer label." }, "gclid": { "type": "string", "description": "Google Ads click identifier." }, "wbraid": { "type": "string", "description": "Google Web to App conversion identifier." }, "gbraid": { "type": "string", "description": "Google App to Web conversion identifier." }, "fbclid": { "type": "string", "description": "Facebook click identifier." }, "msclkid": { "type": "string", "description": "Microsoft Ads click identifier." }, "ttclid": { "type": "string", "description": "TikTok click identifier." }, "twclid": { "type": "string", "description": "Twitter/X click identifier." }, "li_fat_id": { "type": "string", "description": "LinkedIn click identifier." }, "amzclid": { "type": "string", "description": "Amazon Ads click identifier." }, "mc_cid": { "type": "string", "description": "Mailchimp campaign ID." }, "mc_eid": { "type": "string", "description": "Mailchimp subscriber ID." } }, "additionalProperties": true, "description": "Tracking block returned inside a normalized submission blocks object." } ], "description": "One dynamic Forminit block value." }, "description": "Dynamic blocks object returned by Forminit for one submission." }, "files": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "minLength": 1, "description": "File download URL." }, "name": { "type": "string", "description": "Uploaded file name." }, "label": { "type": "string", "description": "Field label or identifier for the file." }, "size": { "type": "integer", "minimum": 0, "description": "File size in bytes." }, "type": { "type": "string", "description": "MIME type of the uploaded file." } }, "additionalProperties": true, "description": "One file metadata entry returned when files=true." }, "description": "Attached file metadata when requested." } }, "additionalProperties": false, "required": [ "id", "submissionDate", "status", "blocks" ], "description": "One submission returned by the Forminit list API." }, "description": "Submissions returned for the requested form." }, "pagination": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "description": "Number of submissions in the current response." }, "currentPage": { "type": "integer", "minimum": 1, "description": "Current page number." }, "total": { "type": "integer", "minimum": 0, "description": "Total number of submissions." }, "firstPage": { "type": "integer", "minimum": 1, "description": "First page number." }, "lastPage": { "type": "integer", "minimum": 1, "description": "Last page number." }, "size": { "type": "integer", "minimum": 1, "description": "Page size used for the current response." } }, "additionalProperties": false, "description": "Pagination metadata returned by the Forminit submissions API." } }, "additionalProperties": false, "required": [ "id", "submissions", "pagination" ], "description": "The data envelope returned by the Forminit submissions API." } }, "additionalProperties": false, "description": "Normalized result returned by the Forminit list submissions API." } }, { "id": "getform.submit_form", "service": "getform", "name": "submit_form", "description": "Submit a protected Forminit form with JSON blocks using the documented sender, tracking, and field block types.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "formId": { "type": "string", "minLength": 1, "description": "The Forminit form ID that will receive the submission." }, "blocks": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "const": "sender", "type": "string", "description": "The sender block type." }, "properties": { "type": "object", "properties": { "email": { "type": "string", "minLength": 1, "description": "Submitter email address." }, "firstName": { "type": "string", "description": "Submitter first name." }, "lastName": { "type": "string", "description": "Submitter last name." }, "fullName": { "type": "string", "description": "Submitter full name." }, "phone": { "type": "string", "description": "Submitter phone number in E.164 format when provided." }, "title": { "type": "string", "description": "Submitter title, such as Mr, Mrs, Dr, or Prof." }, "userId": { "type": "string", "description": "Application-specific submitter identifier." }, "address": { "type": "string", "description": "Submitter street address." }, "city": { "type": "string", "description": "Submitter city." }, "country": { "type": "string", "description": "Submitter country as an ISO 3166-1 alpha-2 code." }, "company": { "type": "string", "description": "Submitter company or organization." }, "position": { "type": "string", "description": "Submitter job title or position." } }, "additionalProperties": false, "description": "Properties accepted by the Forminit sender block." } }, "additionalProperties": false, "description": "Sender block used to describe the submitter." }, { "type": "object", "properties": { "type": { "const": "tracking", "type": "string", "description": "The tracking block type." }, "properties": { "type": "object", "properties": { "utmSource": { "type": "string", "description": "Campaign traffic source, such as google or newsletter." }, "utmMedium": { "type": "string", "description": "Marketing medium, such as cpc or email." }, "utmCampaign": { "type": "string", "description": "Campaign name or identifier." }, "utmTerm": { "type": "string", "description": "Paid keyword or search term." }, "utmContent": { "type": "string", "description": "Ad or content variant identifier." }, "referrer": { "type": "string", "description": "Previous page URL or referrer label." }, "gclid": { "type": "string", "description": "Google Ads click identifier." }, "wbraid": { "type": "string", "description": "Google Web to App conversion identifier." }, "gbraid": { "type": "string", "description": "Google App to Web conversion identifier." }, "fbclid": { "type": "string", "description": "Facebook click identifier." }, "msclkid": { "type": "string", "description": "Microsoft Ads click identifier." }, "ttclid": { "type": "string", "description": "TikTok click identifier." }, "twclid": { "type": "string", "description": "Twitter/X click identifier." }, "li_fat_id": { "type": "string", "description": "LinkedIn click identifier." }, "amzclid": { "type": "string", "description": "Amazon Ads click identifier." }, "mc_cid": { "type": "string", "description": "Mailchimp campaign ID." }, "mc_eid": { "type": "string", "description": "Mailchimp subscriber ID." } }, "additionalProperties": false, "description": "Properties accepted by the Forminit tracking block." } }, "additionalProperties": false, "description": "Tracking block used to send attribution metadata." }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text", "number", "email", "phone", "url", "date", "rating", "select", "radio", "checkbox", "country" ], "description": "Supported JSON field block type." }, "name": { "type": "string", "minLength": 1, "description": "Unique identifier of the field block." }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String field value." }, { "type": "number", "description": "Numeric field value." }, { "type": "boolean", "description": "Boolean field value." } ], "description": "Scalar field value accepted by a supported Forminit field block." }, { "type": "array", "items": { "type": "string", "description": "One selected value." }, "description": "Array of selected string values." } ], "description": "Field block value sent to Forminit." } }, "additionalProperties": false, "description": "One JSON field block supported by the first-pass Getform provider." } ], "description": "One JSON block submitted to Forminit." }, "description": "The JSON blocks payload submitted to Forminit.", "minItems": 1 } }, "additionalProperties": false, "description": "Input payload for submitting a protected Forminit form with JSON blocks." }, "outputSchema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the submission was accepted by Forminit." }, "redirectUrl": { "type": "string", "description": "Thank-you page URL returned by Forminit." }, "submission": { "type": "object", "properties": { "hashId": { "type": "string", "minLength": 1, "description": "Unique submission hash identifier." }, "date": { "type": "string", "minLength": 1, "description": "Submission timestamp in YYYY-MM-DD HH:mm:ss format." }, "blocks": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "String field value." }, { "type": "number", "description": "Numeric field value." }, { "type": "boolean", "description": "Boolean field value." } ], "description": "Scalar field value accepted by a supported Forminit field block." }, { "type": "array", "items": { "type": "string", "description": "One selected value." }, "description": "Array of selected values." }, { "type": "object", "properties": { "email": { "type": "string", "description": "Submitter email address." }, "firstName": { "type": "string", "description": "Submitter first name." }, "lastName": { "type": "string", "description": "Submitter last name." }, "fullName": { "type": "string", "description": "Submitter full name." }, "phone": { "type": "string", "description": "Submitter phone number." }, "title": { "type": "string", "description": "Submitter title." }, "userId": { "type": "string", "description": "Application-specific submitter identifier." }, "address": { "type": "string", "description": "Submitter street address." }, "city": { "type": "string", "description": "Submitter city." }, "country": { "type": "string", "description": "Submitter country code." }, "company": { "type": "string", "description": "Submitter company." }, "position": { "type": "string", "description": "Submitter position." } }, "additionalProperties": true, "description": "Sender block returned inside a normalized submission blocks object." }, { "type": "object", "properties": { "utmSource": { "type": "string", "description": "Campaign traffic source." }, "utmMedium": { "type": "string", "description": "Marketing medium." }, "utmCampaign": { "type": "string", "description": "Campaign identifier." }, "utmTerm": { "type": "string", "description": "Paid keyword or search term." }, "utmContent": { "type": "string", "description": "Ad or content variant identifier." }, "referrer": { "type": "string", "description": "Previous page URL or referrer label." }, "gclid": { "type": "string", "description": "Google Ads click identifier." }, "wbraid": { "type": "string", "description": "Google Web to App conversion identifier." }, "gbraid": { "type": "string", "description": "Google App to Web conversion identifier." }, "fbclid": { "type": "string", "description": "Facebook click identifier." }, "msclkid": { "type": "string", "description": "Microsoft Ads click identifier." }, "ttclid": { "type": "string", "description": "TikTok click identifier." }, "twclid": { "type": "string", "description": "Twitter/X click identifier." }, "li_fat_id": { "type": "string", "description": "LinkedIn click identifier." }, "amzclid": { "type": "string", "description": "Amazon Ads click identifier." }, "mc_cid": { "type": "string", "description": "Mailchimp campaign ID." }, "mc_eid": { "type": "string", "description": "Mailchimp subscriber ID." } }, "additionalProperties": true, "description": "Tracking block returned inside a normalized submission blocks object." } ], "description": "One dynamic Forminit block value." }, "description": "Dynamic blocks object returned by Forminit for one submission." }, "submissionInfo": { "type": "object", "properties": { "ip": { "type": "string", "description": "Source IP address of the submission." }, "user_agent": { "type": "string", "description": "User agent captured for the submission." }, "referer": { "type": "string", "description": "Referrer captured for the submission." }, "location": { "type": "object", "properties": { "country": { "type": "object", "properties": { "name": { "type": "string", "description": "Country name detected for the submission." }, "iso": { "type": "string", "description": "Country ISO 3166-1 alpha-2 code detected for the submission." } }, "additionalProperties": true, "description": "Country information returned inside submission location metadata." }, "city": { "type": "object", "properties": { "name": { "type": "string", "description": "City name detected for the submission." } }, "additionalProperties": true, "description": "City information returned inside submission location metadata." }, "timezone": { "type": "string", "description": "IANA timezone detected for the submission." } }, "additionalProperties": true, "description": "Location metadata returned for a submission when available." } }, "additionalProperties": true, "description": "Submission info metadata returned by Forminit." } }, "additionalProperties": false, "description": "Submission payload returned after a successful Forminit form submission." } }, "additionalProperties": false, "required": [ "success", "submission" ], "description": "Normalized result returned by the Forminit submit form API." } } ] }