Welcome to FillFaster.com API documentation!
\nTo use our REST-API you have to:
\nCreate an account at https://fillfaster.com
\nGet an API token. After the login, go to this page: https://fillfaster.com/account/develop/
\nUse this on all you API reqests, just add it to the request headers
\nThis API will update regularly with new endpoints for you to achieve your purposes.
\nIf you have any questions, suggestions or requests for further integrations, please contact our support.
\nDevelopers Support:
\ncurrently you can just send us a message on the live chat in our website and we will glad to assist you.
\nAuthorization:
\nIn Postman, you can insert your token inside the Authorization section of the Collection.
\nIn your code/platform you have add a header with these key and value :
\nAuthorization : Bearer eyJ0eXAi3O..
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18912453","collectionId":"cd6d2b13-e995-42d6-a325-b902aaa9a09f","publishedId":"2s8ZDVZ3UJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"e05320"},"publishDate":"2023-01-17T17:15:15.000Z"},"item":[{"name":"General","item":[{"name":"Get Forms List","id":"8b0485af-441e-48ab-8c95-f410b0c55361","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.fillfaster.com/v1/getFormsList?sort=created&order=desc&page=1&wid=workspace_id","description":"Getting your account active forms.
Default Sort by is \"created\" date
Defaut order is descending.
Default, and first page, for the pagination is \"1\".
Each page contains maximum of 25 items
optional
\n","type":"text/plain"},"key":"wid","value":"workspace_id"}],"variable":[]}},"response":[{"id":"ae599643-b9ae-4bce-ae76-5e4d64a4c217","name":"Get Forms List","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.fillfaster.com/v1/getFormsList?sort=created&order=desc&page=1","host":["https://api.fillfaster.com"],"path":["v1","getFormsList"],"query":[{"key":"sort","value":"created"},{"key":"order","value":"desc"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"}],"cookie":[],"responseTime":null,"body":"{\n \"total_count\": 3,\n \"items\": [\n {\n \"name\": \"Service Providers Agreement 2023\",\n \"fid\": \"s9I6eGIj\",\n \"submissions\": \"9\",\n \"created\": \"2023-01-26 16:28:35\"\n },\n {\n \"name\": \"Medical insurance questionnaire\",\n \"fid\": \"IGrgmB68\",\n \"submissions\": \"6\",\n \"created\": \"2023-01-23 12:25:37\"\n },\n {\n \"name\": \"Form f1040 IRS\",\n \"fid\": \"IGrgmB234\",\n \"submissions\": \"70\",\n \"created\": \"2023-01-15 16:33:15\"\n }\n ]\n}"}],"_postman_id":"8b0485af-441e-48ab-8c95-f410b0c55361"},{"name":"Get Form Fields","id":"896e6612-7996-4865-8a84-12f012e74774","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"formUID\": \"8TiwB36\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.fillfaster.com/v1/getFormFields","description":"Getting all the available fields for the requested form (by form ID), so you can map them and send data while creating a submission.
\nUpdate the form's settings. all the settings are optional, only sent values will be updated.
\nAll settings are optional, and only sent variables will update.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Get the cucurrent form's settings.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The following example illustrates the structure of a webhook payload that our servers will send as a POST HTTP request to your webhook URL. This sample data provides an overview of the expected fields and their format.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Subscribes a webhook URL to a form. Used by third-party platforms (Make.com, Zapier, etc.) to register a webhook that receives form submission events.
\nEvents (optional): submitted, submission_first_opened, submission_opened, submission_saved. Defaults to submitted if not provided.
Limits: Max 4 webhooks per form. Duplicate URLs are rejected.
\nReturns: The subscribed url and form_id — useful for platforms that need to store the webhook identifier for later detach/unsubscribe calls.
The unique form ID (fid)
\n","type":"text/plain"},"type":"any","value":"","key":"form_id"}]}},"response":[{"id":"6770aaa4-35bf-4a96-a97e-cf3d58f731a7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\",\n \"events\": [\"submitted\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/subscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","subscribe"],"variable":[{"id":"7ab27b64-e1e5-46d1-8e0d-00243e4005bc","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Subscribes a webhook URL to a form. Used by third-party platforms (Make.com, Zapier, etc.) to register a webhook that receives form submission events.\n\n**Events (optional):** `submitted`, `submission_first_opened`, `submission_opened`, `submission_saved`. Defaults to `submitted` if not provided.\n\n**Limits:** Max 4 webhooks per form. Duplicate URLs are rejected.\n\n**Returns:** The subscribed `url` and `form_id` — useful for platforms that need to store the webhook identifier for later detach/unsubscribe calls."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Webhook subscribed successfully\",\n \"url\": \"https://your-platform.com/webhook/receiver\",\n \"form_id\": \"abc123xyz\"\n}"},{"id":"2f0a6a3a-1297-46ce-a1fb-520d0e893bf5","name":"Already subscribed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\",\n \"events\": [\"submitted\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/subscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","subscribe"],"variable":[{"id":"7ab27b64-e1e5-46d1-8e0d-00243e4005bc","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Subscribes a webhook URL to a form. Used by third-party platforms (Make.com, Zapier, etc.) to register a webhook that receives form submission events.\n\n**Events (optional):** `submitted`, `submission_first_opened`, `submission_opened`, `submission_saved`. Defaults to `submitted` if not provided.\n\n**Limits:** Max 4 webhooks per form. Duplicate URLs are rejected.\n\n**Returns:** The subscribed `url` and `form_id` — useful for platforms that need to store the webhook identifier for later detach/unsubscribe calls."},"status":"Conflict","code":409,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Webhook URL already subscribed\"\n}"},{"id":"40b1058a-41f9-4a9e-8514-15272c572a3c","name":"Max limit reached","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\",\n \"events\": [\"submitted\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/subscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","subscribe"],"variable":[{"id":"7ab27b64-e1e5-46d1-8e0d-00243e4005bc","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Subscribes a webhook URL to a form. Used by third-party platforms (Make.com, Zapier, etc.) to register a webhook that receives form submission events.\n\n**Events (optional):** `submitted`, `submission_first_opened`, `submission_opened`, `submission_saved`. Defaults to `submitted` if not provided.\n\n**Limits:** Max 4 webhooks per form. Duplicate URLs are rejected.\n\n**Returns:** The subscribed `url` and `form_id` — useful for platforms that need to store the webhook identifier for later detach/unsubscribe calls."},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Maximum 4 webhooks allowed per form\"\n}"},{"id":"28fc0dc2-e6cf-44af-8837-56ab37cdd5f2","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\",\n \"events\": [\"submitted\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/subscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","subscribe"],"variable":[{"id":"7ab27b64-e1e5-46d1-8e0d-00243e4005bc","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Subscribes a webhook URL to a form. Used by third-party platforms (Make.com, Zapier, etc.) to register a webhook that receives form submission events.\n\n**Events (optional):** `submitted`, `submission_first_opened`, `submission_opened`, `submission_saved`. Defaults to `submitted` if not provided.\n\n**Limits:** Max 4 webhooks per form. Duplicate URLs are rejected.\n\n**Returns:** The subscribed `url` and `form_id` — useful for platforms that need to store the webhook identifier for later detach/unsubscribe calls."},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Form not found or you don't have access to it\"\n}"}],"_postman_id":"115ff600-bfc7-4954-ac9e-b79402abba71"},{"name":"Unsubscribe Webhook","id":"37af57b2-cd4c-4943-b3c8-cb19597f6f1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.fillfaster.com/v1/form/:form_id/webhook/unsubscribe","description":"Unsubscribes (removes) a webhook URL from a form. Used by third-party platforms (Make.com, Zapier, etc.) to deregister a previously subscribed webhook.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"The unique form ID (fid)
\n","type":"text/plain"},"type":"any","value":"","key":"form_id"}]}},"response":[{"id":"680fc67f-5561-49ea-8705-704ed9cad814","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/unsubscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","unsubscribe"],"variable":[{"id":"078ae5b9-33a3-415e-b998-9a7d7aef0094","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Unsubscribes (removes) a webhook URL from a form. Used by third-party platforms (Make.com, Zapier, etc.) to deregister a previously subscribed webhook."},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Webhook unsubscribed successfully\"\n}"},{"id":"3379ed41-4a8e-4181-9ecb-de0f40bb47bf","name":"URL not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/unsubscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","unsubscribe"],"variable":[{"id":"078ae5b9-33a3-415e-b998-9a7d7aef0094","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Unsubscribes (removes) a webhook URL from a form. Used by third-party platforms (Make.com, Zapier, etc.) to deregister a previously subscribed webhook."},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Webhook URL not found\"\n}"},{"id":"79cea1fc-4fe8-4b93-b651-6b1f2270aa69","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://your-platform.com/webhook/receiver\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.fillfaster.com/v1/form/:form_id/webhook/unsubscribe","host":["https://api.fillfaster.com"],"path":["v1","form",":form_id","webhook","unsubscribe"],"variable":[{"id":"078ae5b9-33a3-415e-b998-9a7d7aef0094","key":"form_id","value":"","description":"The unique form ID (fid)"}]},"description":"Unsubscribes (removes) a webhook URL from a form. Used by third-party platforms (Make.com, Zapier, etc.) to deregister a previously subscribed webhook."},"status":"Not Found","code":404,"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Form not found or you don't have access to it\"\n}"}],"_postman_id":"37af57b2-cd4c-4943-b3c8-cb19597f6f1a"}],"id":"65471e6e-9306-47c4-a8dc-b624f51cbe4e","description":"General Calls and functions to have better integration and embedding in your own platform
\n","_postman_id":"65471e6e-9306-47c4-a8dc-b624f51cbe4e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"\n\nNote: If you just want to get submissions without interacting with the API you can use the regular form link, and configure any integration to it, like webhook etc..
\n
Regular form links also support passing prefill data via URL parameters.
example:
This method is used to create a uniqe link for each submission and it also let you check if the client already submitted the document or not.
\nParams:
\nfid - *required - The form template id, all the settings are inherited from it
\nprefill_data - (optional) - Add prefill data in a JSON format
\nuser_data (optional) - Add internal data in a JSON format. This data will not be shown to the user, but you'll receive it back in the webhook for a successful submission.
\nexpiration_date (string, optional) - ISO 8601 date string (YYYY-MM-DD or full ISO).
\nDate Format:
\nYYYY-MM-DDResponse:
\nYou'll get the created submission key, as well as the link you should share with the end user:
\n{ \n\"submission_id\": \"7JLGZLt3\",\n\"submission_link\": \"https://fillfaster.com/fills/7JLGZLt3\"\n}\n\nOr an error with an explanation message
\nSave this key to check later the submission status and to get it's files
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Unlike the Create Submission method, this method allows you to send an array of submission data and receive an array of responses in return. If there is an error for a specific item in the array, it will be placed in the correct position in the array.
\n**Params:**An array of:
\nfid - *required - The form template id, all the settings are inherited from it
\nprefill_data - optional - Add prefill data in a JSON format
\nuser_data - optional - Add internal data in a JSON format. This data will not be shown to the user, but you'll receive it back in the webhook for a successful submission.
\n*Currently, a maximum of 20 items are allowed.
\nEndFragment
\nResponse:
\nYou'll get an array of the created submissions key, as well as the link you should share with the end user:
\n{\n \"submissions\": [\n {\n \"submission_id\": \"wOCMkUhK\",\n \"submission_link\": \"https://fillfaster.com/fills/wOCMkUhK\"\n },\n {\n \"submission_id\": \"ZM4x1fwD\",\n \"submission_link\": \"https://fillfaster.com/fills/ZM4x1fwD\"\n },\n {\n \"status\": 400,\n \"error\": \"The form does not exist, or you do not have access to it. fid: YpmAW97\"\n }\n ]\n}\n\nOr an error with an explanation message
\nSave this key to check later the submission status and to get it's files
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"\n\nNote: If you configured webhook to the form, you are going to get a real time notifications for new submissions.
\n
With this method you can manually check if a specific submission has been submitted already or not.
\nParameters:
\nsubmissionID - *required - replace this with the submission key
\nResponse:
\nYou'll get the status of the submission:
\n{\"status\":\"Submitted\"}
{\"status\":\"Not Submitted Yet\"}
After successful submission by the end user, you can get the submitted signed PDF file by calling this method.
\nIf the file is available it'll be returend as a file.
\nParameters:
\nsubmissionID - *required - replace this with the submission key
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Getting the submissions of specific form.
Default Sort by is \"created\" date
Defaut order is descending.
Default, and first page, for the pagination is \"1\".
Each page contains maximum of 25 items
Params:
\none or more fields of a submission (currently supports expiration_date, note, and access_code). Only the owner or an admin can update.
\nAll fiefields are optional, and only sent variables will update.
\nError Responses:
\n400: Invalid input, missing sid, invalid date, or no fields to update.
\n403: No permission.
\n404: Submission not found.
\nThis function takes a form ID and \"prefill_data\" as input, and returns a filled PDF file. The function uses the form ID to retrieve the template of the form, and then adds the fields data on top of the template. The function handles the formatting, alignment etc of the fields data according to the template specifications. The function returns a PDF file that contains the filled form, or an error message if the input is invalid or the API request fails.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"