{ "uuid": "b48c27c8-f53e-4e29-9f75-620667616cff", "lastMigration": 29, "name": "API v1", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "8eb61af1-fec0-420b-8ec1-9d278f34a790", "documentation": "Test Authentication", "method": "get", "endpoint": "authentication", "responses": [ { "uuid": "5552a6fb-096c-4603-b3b2-1885fc23ab6f", "body": "{\n \"status\": \"{{oneOf (array 'success')}}\"\n}", "latency": 0, "statusCode": 200, "label": "authentication succeeded", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "efd8e1e3-831c-4f82-af7a-4cb7c7c0e96d", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4086d6b8-99ec-4c80-9b29-fbfb5f86ca19", "documentation": "Merge generated PDFs together", "method": "post", "endpoint": "combined_submissions", "responses": [ { "uuid": "ed187288-c523-41a3-9f90-975e50346c00", "body": "{\n \"combined_submission\": {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"download_url\": \"\",\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"source_pdfs\": [\n {\n \"id\": \"\",\n \"type\": \"{{oneOf (array 'submission' 'combined_submission' 'template' 'custom_file')}}\"\n }\n ],\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submission_ids\": [\n \"\"\n ]\n },\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 201, "label": "combined submission created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4e00d51c-b7aa-4790-9bec-9d653b815fce", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "invalid JSON", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "44fb91dc-4194-4e11-b22e-a116aae710be", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bd22bbce-6dab-4b7d-85fc-e936644d2f16", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 422, "label": "invalid request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4bded836-1c3c-4e91-8451-dd3d4c377fe8", "documentation": "Expire a combined submission", "method": "delete", "endpoint": "combined_submissions/:combined_submission_id", "responses": [ { "uuid": "03c3e648-e93b-4d6b-999c-0ebd9dfe4b4e", "body": "{\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"download_url\": \"\",\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"source_pdfs\": [\n {\n \"id\": \"\",\n \"type\": \"{{oneOf (array 'submission' 'combined_submission' 'template' 'custom_file')}}\"\n }\n ],\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submission_ids\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "submission was expired", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d9c08144-19ca-4a2c-bfdc-d89fe39cc4da", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b2e41034-1b91-4a66-9e96-90b9f3adb821", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "test API token used", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fdc32921-c454-4b9d-952a-f45e0b5d6ef7", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "combined submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b11a0462-b6e3-400a-bd4f-5684eabe615d", "documentation": "Check the status of a combined submission (merged PDFs)", "method": "get", "endpoint": "combined_submissions/:combined_submission_id", "responses": [ { "uuid": "cde1f33b-8394-4650-8e28-fac543b6470c", "body": "{\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"download_url\": \"\",\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"source_pdfs\": [\n {\n \"id\": \"\",\n \"type\": \"{{oneOf (array 'submission' 'combined_submission' 'template' 'custom_file')}}\"\n }\n ],\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submission_ids\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "processed combined submission found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "47d87e95-6583-4834-90e3-7989f94f2852", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f8820116-5cc5-474a-8260-4ad363c64d43", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "combined submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b2b5409-3959-44be-b640-b9cdddf26df2", "documentation": "Merge submission PDFs, template PDFs, or custom files", "method": "post", "endpoint": "combined_submissions?v=2", "responses": [ { "uuid": "e941c24d-7b59-457e-a527-e2fbece4c306", "body": "{\n \"combined_submission\": {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"download_url\": \"\",\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"source_pdfs\": [\n {\n \"id\": \"\",\n \"type\": \"{{oneOf (array 'submission' 'combined_submission' 'template' 'custom_file')}}\"\n }\n ],\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submission_ids\": [\n \"\"\n ]\n },\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 201, "label": "combined submission created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c455bb97-2eb5-4d49-816e-9791c56ce009", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "invalid JSON", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0df29b7c-3c59-40c1-8858-6223115ea447", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c9247bde-2564-4c42-aaf1-3d5b04a05059", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 422, "label": "invalid request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "097f91ce-5f72-47ca-8cc4-07adb91a895a", "documentation": "Create a new custom file from a cached presign upload", "method": "post", "endpoint": "custom_files", "responses": [ { "uuid": "bc408251-8984-48c9-a129-ac8e4a278033", "body": "{\n \"custom_file\": {\n \"id\": \"\",\n \"url\": \"\"\n },\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 201, "label": "returns the custom file", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8b3db1b4-d3ca-4989-8d28-77b851c4477f", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1d90ffe2-8f38-4688-bbee-ce6daf79782a", "documentation": "Look up a submission data request", "method": "get", "endpoint": "data_requests/:data_request_id", "responses": [ { "uuid": "31aa9734-e777-461f-b880-4e74334edf47", "body": "{\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "completed submission data request found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2b9a5a0e-03a8-4fc7-acfd-d882a57ddcb9", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3de9391d-4705-4fd2-8cc3-b430c4a65fcd", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "submission data request not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ddc86af7-d068-4efa-a354-d890d492631a", "documentation": "Update a submission data request", "method": "put", "endpoint": "data_requests/:data_request_id", "responses": [ { "uuid": "21a549e9-a97f-4638-a19c-1f1d5c4d22aa", "body": "{\n \"data_request\": {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n },\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "submission data request updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "863a944c-140c-4a1b-a224-8623ae4417bc", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "36aa4b28-3caf-4917-b639-ccdef38e4d24", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "submission data request not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "03043976-30f4-471d-931c-ad5b1aecc293", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 422, "label": "invalid request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b46533f6-1153-4dcc-a734-cea7819ae270", "documentation": "Creates a new data request token for form authentication", "method": "post", "endpoint": "data_requests/:data_request_id/tokens", "responses": [ { "uuid": "4a922b0c-98a9-4d2f-a0d6-bdc570e3ac80", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\",\n \"token\": {\n \"data_request_url\": \"\",\n \"expires_at\": \"\",\n \"id\": \"\",\n \"secret\": \"\"\n }\n}", "latency": 0, "statusCode": 201, "label": "token created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5f05a1b1-99f2-4c2b-838e-9e7c7a9dacfa", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "976af9a0-0deb-4fa6-bf80-a8b0f5e63e18", "documentation": "Get a list of all folders", "method": "get", "endpoint": "folders/", "responses": [ { "uuid": "0bb0de9e-169b-4949-8766-548e9f5a967e", "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "enumerate all folders", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b10d793a-d6a9-4312-bc94-f38b38f93988", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d39ed80-383f-4cd7-8d55-918575e498bb", "documentation": "Create a folder", "method": "post", "endpoint": "folders/", "responses": [ { "uuid": "ca634566-f3ea-49c8-b7c8-fe9756159dac", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "folder created inside another folder", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4759cb7b-88dc-4d93-a79b-425a9e508855", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "62c3f6d1-4eb9-4959-bdfd-0a2b67aaa481", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "parent folder doesnt exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "441b0aa0-9bb5-444f-9863-b39a4b3435ea", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "name already exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b8842fd5-a1f2-45af-8a11-15e6e56e832d", "documentation": "Delete a folder", "method": "delete", "endpoint": "folders/:folder_id", "responses": [ { "uuid": "3f08ca1f-8742-4fb3-ab5b-e78fa371bba1", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "folder is empty", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "cd4a97c4-24dc-40e1-bc79-7904a716ab33", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0b313f38-977e-4562-b41b-349f323a1309", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "folder doesnt exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f531e914-8c5b-4c84-9f95-4d425d1357c4", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 422, "label": "folder has contents", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "52d05a8f-c0f3-4121-b10a-fe062363e23e", "documentation": "Move a folder", "method": "post", "endpoint": "folders/:folder_id/move", "responses": [ { "uuid": "0d0897cc-510b-4999-8ab8-bc68329177c3", "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "move to root folder", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "50b97af7-648e-4a41-bdf8-ed66d56fc9a2", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fe9eb165-e5f3-45fa-a47c-2e431af31135", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "parent folder doesnt exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8ea81218-b3a1-4b6d-be8c-1956d2e2db48", "documentation": "Rename a folder", "method": "post", "endpoint": "folders/:folder_id/rename", "responses": [ { "uuid": "1908b6cd-d39a-463a-8936-bf16fe6564f9", "body": "", "latency": 0, "statusCode": 200, "label": "successful rename", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "da51371f-f3bd-4e03-8e22-ddd4c62a37db", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fad82541-c84a-411c-9c65-d89370aab1d6", "body": "", "latency": 0, "statusCode": 404, "label": "folder doesnt belong to me", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86926dad-b97f-4093-9728-f45d03c37bd6", "body": "", "latency": 0, "statusCode": 422, "label": "name already exist", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "668226e7-aceb-4b6a-8762-afa5fdce57d4", "documentation": "Generates multiple PDFs", "method": "post", "endpoint": "submissions/batches", "responses": [ { "uuid": "fc35ce7e-f6c1-4b1a-985d-2fc8972e7bb4", "body": "{\n \"error\": \"\",\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\",\n \"submission_batch\": {\n \"completion_percentage\": {{faker 'number.int' max=99999}},\n \"error_count\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"pending_count\": {{faker 'number.int' max=99999}},\n \"processed_at\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submissions\": [\n {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n ],\n \"total_count\": {{faker 'number.int' max=99999}}\n },\n \"submissions\": [\n {\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error' 'valid_but_not_saved')}}\",\n \"submission\": {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "some PDFs with invalid data", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "89ad1fed-66c3-4dfa-a33d-d4c20dbe12cf", "body": "{\n \"error\": \"\",\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\",\n \"submission_batch\": {\n \"completion_percentage\": {{faker 'number.int' max=99999}},\n \"error_count\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"pending_count\": {{faker 'number.int' max=99999}},\n \"processed_at\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submissions\": [\n {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n ],\n \"total_count\": {{faker 'number.int' max=99999}}\n },\n \"submissions\": [\n {\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error' 'valid_but_not_saved')}}\",\n \"submission\": {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "submissions created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a2fa79f2-1188-4e3a-a16c-d3f55fb23d07", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "invalid JSON", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "866a6e63-54dd-4ec3-b3ee-e606d9626993", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f33af78d-5eba-467d-b5cd-208e165249aa", "documentation": "Check the status of a submission batch job", "method": "get", "endpoint": "submissions/batches/:submission_batch_id", "responses": [ { "uuid": "24ca5e24-3e1d-42a1-aa31-0d6b0cabdb57", "body": "{\n \"completion_percentage\": {{faker 'number.int' max=99999}},\n \"error_count\": {{faker 'number.int' max=99999}},\n \"id\": \"\",\n \"metadata\": {},\n \"pending_count\": {{faker 'number.int' max=99999}},\n \"processed_at\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'error')}}\",\n \"submissions\": [\n {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n ],\n \"total_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "processed submission batch found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "92dbbedf-ebd9-43a6-be7f-f41f34554f60", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bf6fffa0-39cc-49fc-94eb-5673a801cda9", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "submission batch not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3ac5cecd-574b-4b93-b855-1461a8264462", "documentation": "Expire a PDF submission", "method": "delete", "endpoint": "submissions/:submission_id", "responses": [ { "uuid": "414d0d72-3b5d-440e-ba4a-6a844323d59e", "body": "{\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n}", "latency": 0, "statusCode": 200, "label": "submission was expired", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "616c2212-10bf-4d37-b28b-b249482e9d76", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3518521e-b510-4c41-b243-3bb4cc7ef2e9", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 403, "label": "test API token used", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "521e2660-3682-424e-b304-ce549ca8646c", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c217755f-fdb3-4d2d-a377-8c3acf88bdac", "documentation": "Check the status of a PDF", "method": "get", "endpoint": "submissions/:submission_id", "responses": [ { "uuid": "eb10341e-5150-4f7a-a423-bc77385d7c06", "body": "{\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n}", "latency": 0, "statusCode": 200, "label": "processed submission found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "64f0816c-dc7d-40bb-a18f-cfb195590b9c", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4e620f2e-6ce3-405a-908f-6f80f871d6de", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "submission not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c3c6b8a-adc0-4d55-bb4a-1bb59a76a35a", "documentation": "Get a list of all templates", "method": "get", "endpoint": "templates", "responses": [ { "uuid": "537ce604-823e-41a6-a130-345f20768e4a", "body": "[\n {\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"document_url\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"page_dimensions\": [\n [\n {{faker 'number.int' max=99999}}\n ]\n ],\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"permanent_document_url\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "enumerate all templates", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "62b11dd2-9677-4eae-acc3-050c815ba003", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "95fbe7f4-3830-4e60-9836-41214fc0a052", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "filter templates by invalid folder id", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9ab8988b-9fb3-4d93-9de4-e9e10525f24d", "documentation": "Create a new PDF template with a form POST file upload", "method": "post", "endpoint": "templates", "responses": [ { "uuid": "b685fce3-419c-4f6c-9e32-cb41aebd7146", "body": "{\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "returns a pending template", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6debbaa8-84b3-4e87-a50a-1c31de869982", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c439b79a-1ae0-4779-a6c9-02c37a9e91f4", "documentation": "Get a single template", "method": "get", "endpoint": "templates/:template_id", "responses": [ { "uuid": "b8b7dde7-ccf7-493a-9aae-b6ccffbd9c19", "body": "{\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"document_url\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"page_dimensions\": [\n [\n {{faker 'number.int' max=99999}}\n ]\n ],\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"permanent_document_url\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "template found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9e54d4d6-e28c-4c5f-af00-5d90e24b9f43", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1958c312-db0b-4dd9-81aa-86ef85ff8425", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "template not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "40246c46-a8d0-4b23-848e-ae6e7bfe0352", "documentation": "Update a Template", "method": "put", "endpoint": "templates/:template_id", "responses": [ { "uuid": "4c663381-e2e1-418f-bf56-e71e0ca410fc", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "update template success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "255027fa-19a1-4629-9243-47972e7e4108", "documentation": "Add new fields to a Template", "method": "put", "endpoint": "templates/:template_id/add_fields", "responses": [ { "uuid": "58adf3ac-7ade-468c-abd2-2e6a27cd9370", "body": "{\n \"errors\": [\n \"\"\n ],\n \"new_field_ids\": [\n {{faker 'number.int' max=99999}}\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 200, "label": "add fields success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2cfd7bfa-57c7-432f-9764-3567dd3142da", "body": "{\n \"errors\": [\n \"\"\n ],\n \"new_field_ids\": [\n {{faker 'number.int' max=99999}}\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\"\n}", "latency": 0, "statusCode": 422, "label": "add fields error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "21062b75-4e83-4ba3-b6ef-2d0dcee878bb", "documentation": "Copy a Template", "method": "post", "endpoint": "templates/:template_id/copy", "responses": [ { "uuid": "c28a5444-a141-47c8-b974-2efcfb6381a8", "body": "{\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"document_url\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"page_dimensions\": [\n [\n {{faker 'number.int' max=99999}}\n ]\n ],\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"permanent_document_url\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "copy template success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fde5b933-18e5-4618-9ade-7b602bb92f33", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "folder not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "02eb1aa4-1daf-40e1-80b5-6363aa3ffb52", "documentation": "Move Template to folder", "method": "post", "endpoint": "templates/:template_id/move", "responses": [ { "uuid": "36f2daf0-9ee6-41a0-aaa8-cd39dead82e7", "body": "{\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"document_url\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"page_dimensions\": [\n [\n {{faker 'number.int' max=99999}}\n ]\n ],\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"permanent_document_url\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "move template success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b6d92c40-64c3-408b-9407-78226b9cbe12", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "folder not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "da7ad1b5-aee1-46c8-8a18-c0c5417f1973", "documentation": "Fetch the JSON schema for a template", "method": "get", "endpoint": "templates/:template_id/schema", "responses": [ { "uuid": "6fa805a3-f773-4a32-b994-c02df1ec693b", "body": "{\n \"$schema\": \"\",\n \"additionalProperties\": {{faker 'datatype.boolean'}},\n \"definitions\": {},\n \"description\": \"\",\n \"id\": \"\",\n \"properties\": {},\n \"required\": [\n \"\"\n ],\n \"title\": \"\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "template found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2cfb672c-3a1e-4362-a20a-fea17543221a", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9f93142f-0dce-4a88-b8c3-37aa6ab5d5c6", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 404, "label": "template not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "289a238e-48d4-4b28-b075-b70ebee4ccb0", "documentation": "Generates a new PDF", "method": "post", "endpoint": "templates/:template_id/submissions", "responses": [ { "uuid": "c92d0ddf-a9a3-4f1c-9d15-f0eb9466ce87", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\",\n \"submission\": {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n}", "latency": 0, "statusCode": 201, "label": "submission created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f12b0a5a-9c79-4245-a6f0-1f75345e28f4", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "invalid JSON", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "73dbe547-8dc1-4cc5-862b-4dd434050552", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0bb88e4a-3081-4d15-a2cc-bb0d53b4b344", "body": "{\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 422, "label": "invalid request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a9a4cce7-c1b4-432a-8766-505964ee9e49", "documentation": "Generates multiple PDFs", "method": "post", "endpoint": "templates/:template_id/submissions/batch", "responses": [ { "uuid": "91ebc0f4-0298-476d-a8d2-0a9a023e3d95", "body": "[\n {\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'success' 'error')}}\",\n \"submission\": {\n \"actions\": [\n {\n \"action_category\": \"{{oneOf (array 'notification' 'file_upload')}}\",\n \"action_type\": \"{{oneOf (array 'webhook' 'slack_webhook' 'email' 'aws_s3_upload')}}\",\n \"id\": \"\",\n \"integration_id\": \"\",\n \"result_data\": {},\n \"state\": \"{{oneOf (array 'pending' 'processed' 'failed' 'error')}}\"\n }\n ],\n \"batch_id\": \"\",\n \"data\": {},\n \"data_requests\": [\n {\n \"auth_phone_number_hash\": \"\",\n \"auth_provider\": \"\",\n \"auth_second_factor_type\": \"{{oneOf (array 'none' 'phone_number' 'totp' 'mobile_push' 'security_key' 'fingerprint')}}\",\n \"auth_session_id_hash\": \"\",\n \"auth_session_started_at\": \"\",\n \"auth_type\": \"{{oneOf (array 'none' 'password' 'oauth' 'email_link' 'phone_number' 'ldap' 'saml')}}\",\n \"auth_user_id_hash\": \"\",\n \"auth_username_hash\": \"\",\n \"completed_at\": \"\",\n \"email\": \"\",\n \"fields\": [\n \"\"\n ],\n \"id\": \"\",\n \"ip_address\": \"\",\n \"metadata\": {},\n \"name\": \"\",\n \"order\": {{faker 'number.int' max=99999}},\n \"sort_order\": {{faker 'number.int' max=99999}},\n \"state\": \"{{oneOf (array 'pending' 'completed')}}\",\n \"user_agent\": \"\",\n \"viewed_at\": \"\"\n }\n ],\n \"download_url\": \"\",\n \"editable\": {{faker 'datatype.boolean'}},\n \"expired\": {{faker 'datatype.boolean'}},\n \"expires_at\": \"\",\n \"id\": \"\",\n \"metadata\": {},\n \"pdf_hash\": \"\",\n \"permanent_download_url\": \"\",\n \"processed_at\": \"\",\n \"referrer\": \"\",\n \"source\": \"\",\n \"state\": \"{{oneOf (array 'pending' 'processed' 'invalid_data' 'error' 'image_download_failed' 'image_processing_failed' 'waiting_for_data_requests' 'syntax_error' 'account_suspended' 'license_revoked' 'accidental')}}\",\n \"template_id\": \"\",\n \"test\": {{faker 'datatype.boolean'}},\n \"truncated_text\": {}\n }\n }\n]", "latency": 0, "statusCode": 201, "label": "submissions created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c584e47d-45ee-401d-bd09-50c1b9d535c0", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 400, "label": "invalid JSON", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f05326e1-d4f5-481f-9731-c5b758aab2f6", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b8a29d90-9c6c-47b9-8386-31b70f50c761", "body": "[\n {\n \"errors\": [\n \"\"\n ],\n \"status\": \"{{oneOf (array 'error')}}\"\n }\n]", "latency": 0, "statusCode": 422, "label": "invalid requests", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "81913d39-c81a-4e0f-84d3-f4b1dffb2201", "documentation": "Create a new PDF template from a cached presign upload", "method": "post", "endpoint": "templates?desc=cached_upload", "responses": [ { "uuid": "366aacda-fce6-4694-955e-0ffca4fa21b0", "body": "{\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "returns a pending template", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b3896e89-d8a5-4613-be5a-ac7b109934c7", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c187274-9970-4fca-947b-6a09aa0639e5", "documentation": "Create a new HTML template", "method": "post", "endpoint": "templates?desc=html", "responses": [ { "uuid": "9edea5ef-91d5-45dc-8d61-e80905cce87c", "body": "{\n \"allow_additional_properties\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"editable_submissions\": {{faker 'datatype.boolean'}},\n \"expiration_interval\": \"{{oneOf (array 'minutes' 'hours' 'days')}}\",\n \"expire_after\": {{faker 'number.int' max=99999}},\n \"expire_submissions\": {{faker 'datatype.boolean'}},\n \"id\": \"\",\n \"locked\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"parent_folder_id\": \"\",\n \"path\": \"\",\n \"public_submissions\": {{faker 'datatype.boolean'}},\n \"public_web_form\": {{faker 'datatype.boolean'}},\n \"redirect_url\": \"\",\n \"slack_webhook_url\": \"\",\n \"template_type\": \"\",\n \"webhook_url\": \"\"\n}", "latency": 0, "statusCode": 201, "label": "returns a created template", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8dcdc876-e5a1-4672-b42d-eda83f55714d", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "58b6455e-9e14-443b-bf90-d7212be11b09", "documentation": "Get a presigned URL so that you can upload a file to our AWS S3 bucket", "method": "get", "endpoint": "uploads/presign", "responses": [ { "uuid": "8539909d-ec9d-4d85-9212-64807634b847", "body": "{\n \"fields\": {\n \"key\": \"\",\n \"policy\": \"\",\n \"x-amz-algorithm\": \"\",\n \"x-amz-credential\": \"\",\n \"x-amz-date\": \"\",\n \"x-amz-signature\": \"\"\n },\n \"headers\": {},\n \"method\": \"{{oneOf (array 'post')}}\",\n \"url\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "presign URL generated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8f0dc92b-b6da-466e-9de3-7f40d7c4d7c9", "body": "{\n \"error\": \"\",\n \"status\": \"{{oneOf (array 'error')}}\"\n}", "latency": 0, "statusCode": 401, "label": "authentication failed", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "8eb61af1-fec0-420b-8ec1-9d278f34a790" }, { "type": "route", "uuid": "4086d6b8-99ec-4c80-9b29-fbfb5f86ca19" }, { "type": "route", "uuid": "4bded836-1c3c-4e91-8451-dd3d4c377fe8" }, { "type": "route", "uuid": "b11a0462-b6e3-400a-bd4f-5684eabe615d" }, { "type": "route", "uuid": "9b2b5409-3959-44be-b640-b9cdddf26df2" }, { "type": "route", "uuid": "097f91ce-5f72-47ca-8cc4-07adb91a895a" }, { "type": "route", "uuid": "1d90ffe2-8f38-4688-bbee-ce6daf79782a" }, { "type": "route", "uuid": "ddc86af7-d068-4efa-a354-d890d492631a" }, { "type": "route", "uuid": "b46533f6-1153-4dcc-a734-cea7819ae270" }, { "type": "route", "uuid": "976af9a0-0deb-4fa6-bf80-a8b0f5e63e18" }, { "type": "route", "uuid": "6d39ed80-383f-4cd7-8d55-918575e498bb" }, { "type": "route", "uuid": "b8842fd5-a1f2-45af-8a11-15e6e56e832d" }, { "type": "route", "uuid": "52d05a8f-c0f3-4121-b10a-fe062363e23e" }, { "type": "route", "uuid": "8ea81218-b3a1-4b6d-be8c-1956d2e2db48" }, { "type": "route", "uuid": "668226e7-aceb-4b6a-8762-afa5fdce57d4" }, { "type": "route", "uuid": "f33af78d-5eba-467d-b5cd-208e165249aa" }, { "type": "route", "uuid": "3ac5cecd-574b-4b93-b855-1461a8264462" }, { "type": "route", "uuid": "c217755f-fdb3-4d2d-a377-8c3acf88bdac" }, { "type": "route", "uuid": "3c3c6b8a-adc0-4d55-bb4a-1bb59a76a35a" }, { "type": "route", "uuid": "9ab8988b-9fb3-4d93-9de4-e9e10525f24d" }, { "type": "route", "uuid": "c439b79a-1ae0-4779-a6c9-02c37a9e91f4" }, { "type": "route", "uuid": "40246c46-a8d0-4b23-848e-ae6e7bfe0352" }, { "type": "route", "uuid": "255027fa-19a1-4629-9243-47972e7e4108" }, { "type": "route", "uuid": "21062b75-4e83-4ba3-b6ef-2d0dcee878bb" }, { "type": "route", "uuid": "02eb1aa4-1daf-40e1-80b5-6363aa3ffb52" }, { "type": "route", "uuid": "da7ad1b5-aee1-46c8-8a18-c0c5417f1973" }, { "type": "route", "uuid": "289a238e-48d4-4b28-b075-b70ebee4ccb0" }, { "type": "route", "uuid": "a9a4cce7-c1b4-432a-8766-505964ee9e49" }, { "type": "route", "uuid": "81913d39-c81a-4e0f-84d3-f4b1dffb2201" }, { "type": "route", "uuid": "3c187274-9970-4fca-947b-6a09aa0639e5" }, { "type": "route", "uuid": "58b6455e-9e14-443b-bf90-d7212be11b09" } ] }