{
  "info": {
    "name": "RapidoForm Developer API",
    "description": "Account API: forms, questions, themes, media, responses and webhooks. Synthetic IDs only. Configure variables privately. Writes and deletes modify real resources; test with disposable development forms.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://www.rapidoform.com/be"
    },
    {
      "key": "email",
      "value": ""
    },
    {
      "key": "apiKey",
      "value": ""
    },
    {
      "key": "surveyId",
      "value": "12345"
    },
    {
      "key": "questionId",
      "value": "000000000000000000000001"
    },
    {
      "key": "themeId",
      "value": "000000000000000000000002"
    },
    {
      "key": "webhookId",
      "value": "000000000000000000000003"
    },
    {
      "key": "respondentsId",
      "value": "EXAMPLE_RESPONDENT"
    },
    {
      "key": "mediaFileName",
      "value": "userId_EXAMPLE%2Forigin_addMedia%2FImage%2Fexample.png"
    }
  ],
  "item": [
    {
      "name": "create",
      "item": [
        {
          "name": "Create a form",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/survey/create",
            "description": "Creates a Draft form, a welcome question at order 0, and form settings. Save Data[0].surveyDetails._id for subsequent calls. Free accounts may create at most 3 forms; account expiry also applies (Admin exceptions exist).",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"surveyName\": \"Customer feedback\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Retrieve forms",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/surveys/1/all",
            "description": "Filters and pagination belong in the path: /api/surveys/2/draft. totalSurveys counts all matches, not just this page."
          }
        },
        {
          "name": "Retrieve a form",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/survey/{{surveyId}}",
            "description": ""
          }
        },
        {
          "name": "Update a form",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/survey/update/{{surveyId}}",
            "description": "Send only fields to change. Setting status to Collecting validates question configuration. Free plans cannot publish forms containing Payment Question or FileUpload Question. A plan record is required. Ownership/workspace IDs, timestamps, update operators and dotted keys are not editable through this endpoint.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"SurveyName\": \"Updated feedback\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a form",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/survey/delete/",
            "description": "Permanently removes the form and associated questions, respondents, answers, settings and integration records. Use a disposable development form when testing.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"_ids\": {{surveyId}}\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Create a question",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/question",
            "description": "Use an active account and a form in your workspace. Type-specific fields supported at creation include optionRandomOrder, ratingScale, ratingType, schedulingUrl, translationLanguages, translations, stimuliMedia, rowItems, columnItems, setTimeMinimum, timeMinimum, setMinTextLength, minTextLength, setMaxTextLength, maxTextLength, mediaPlayback, setMediaMaxDuration, mediaMaxDuration, imageChoices, imagesCountPerRow, audioPlayerType, silenceCheck, shuffleImages, ratingSliderOn, statementQueBtnText, lowerBoundLevel, upperBoundLevel, lowerBoundNumber, upperBoundNumber, sliderIncrement and makeAudioOptional. NPS Question forces ratingScale to 10. To insert between questions, send isBetweenAdded: true and numeric isBetweenAddedOrder. Retrieve an existing builder question as the starting point for complex types; creation accepts the fields listed here rather than every stored question field.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"surveyId\": \"{{surveyId}}\",\n  \"questionOrder\": 1,\n  \"questionText\": \"How can we improve?\",\n  \"questionType\": \"Text Question\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Retrieve form questions",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/questions/{{surveyId}}",
            "description": "Questions are sorted by questionOrder."
          }
        },
        {
          "name": "Retrieve a question",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/question/{{questionId}}",
            "description": "Question access is checked against its stored parent form. Missing questions return HTTP 404; malformed IDs return HTTP 400."
          }
        },
        {
          "name": "Update a question",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/question/{{questionId}}",
            "description": "surveyId must match the question’s stored parent form. Foreign-workspace questions are denied. Send only editable fields: ownership fields, update operators and dotted keys are rejected. Logic rules are validated when rule is supplied.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"surveyId\": \"{{surveyId}}\",\n  \"questionText\": \"What could work better?\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a question",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/question/{{questionId}}",
            "description": "Deletes the question and reorders the remaining questions."
          }
        },
        {
          "name": "Create a theme",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/theme",
            "description": "themeCreatorId is assigned from the authenticated user. Assign the returned theme ID to a form through Update a form.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"themeName\": \"Brand theme\",\n  \"backgroundColor\": \"#ffffff\",\n  \"btnBackgroundColor\": \"#1d4ed8\",\n  \"btnTextColor\": \"#ffffff\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Retrieve workspace themes",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/mytheme",
            "description": "Returns themes for your workspace; an empty workspace returns myTheme: []."
          }
        },
        {
          "name": "Retrieve gallery themes",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/theme/gallery",
            "description": "Returns themes marked isGalleryTheme."
          }
        },
        {
          "name": "Retrieve a form theme",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/theme/survey/{{surveyId}}",
            "description": "Returns the assigned theme, with a default-theme fallback."
          }
        },
        {
          "name": "Update a theme",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/theme/{{themeId}}",
            "description": "Requires a writable Owner/Admin account and a theme you created or a private theme in your workspace. Clone gallery themes before changing them. Missing themes return HTTP 404. Send only editable fields; ownership, gallery flags, timestamps and update operators are rejected. This returns a confirmation message; retrieve the form/workspace theme to inspect its values.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"backgroundColor\": \"#f8fafc\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a theme",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/theme/{{themeId}}",
            "description": "Requires a writable Owner/Admin account and a theme you created or a private theme in your workspace. Shared gallery themes cannot be deleted by other users. Missing themes return HTTP 404. Check forms using the theme before deleting it."
          }
        },
        {
          "name": "Upload an image",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/get/uploadImage",
            "description": "Let curl or your HTTP client set the multipart boundary. Storage limits apply; exhausted storage returns HTTP 402. Save the returned fileName for deletion and fileLink for display. A missing multipart media file returns HTTP 400.",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "media",
                  "type": "file",
                  "src": []
                }
              ]
            }
          }
        },
        {
          "name": "Delete an image",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/delete/deleteImage/{{mediaFileName}}",
            "description": "Media ownership is checked before deletion. Use the returned fileName, not fileLink."
          }
        }
      ]
    },
    {
      "name": "responses",
      "item": [
        {
          "name": "Retrieve respondents",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/respondents/{{surveyId}}/1/10/2026-01-01/2026-12-31/false",
            "description": "Fill earlier optional path positions before later ones. Pagination, dates and bookmark are path parameters, not query filters. Preview respondents are excluded. totalResponse is the total matching count. This endpoint does not filter exclusively for completed submissions."
          }
        },
        {
          "name": "Retrieve answers for a respondent",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/response/questionwise/{{respondentsId}}?surveyId={{surveyId}}",
            "description": "Returns result entries with question, userResponse, enableQuestion, respondentsId and respondents. The answer shape depends on the question type. Use surveyId to disambiguate repeated respondent IDs."
          }
        },
        {
          "name": "Retrieve answers for a question",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/response/respondentwise/{{questionId}}/2026-01-01/2026-12-31/1/10/false",
            "description": "Returns result and totalQuestionResponse. Answer fields vary by question type, including userResponse and joined question/respondents details."
          }
        },
        {
          "name": "Retrieve report questions",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/response/questions/{{surveyId}}/2026-01-01/2026-12-31",
            "description": "Returns the form’s questions with totalResponse as the question count, not a submission count."
          }
        },
        {
          "name": "Retrieve question graph data",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/response/questiongraph/{{questionId}}/2026-01-01/2026-12-31",
            "description": "Data[0].result contains graph entries derived from answers. graphData and associated question fields vary by question type; an empty result is valid."
          }
        },
        {
          "name": "Retrieve form insights",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/response/insightsgraph/{{surveyId}}/2026-01-01/2026-12-31",
            "description": "Data[0] contains surveyStartedGraphData, surveyCompletedGraphData, questionAttemptedGraphData, avgEachQuestionGraphData, deviceTypeGraphData, totalCompleteSurveyData and avgCompletiontTimeData (spelling is part of the API). This route does not expose a bookmark parameter."
          }
        },
        {
          "name": "Export answers as JSON",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/survey/dataformat3/{{surveyId}}/false",
            "description": "Data is the export array itself, without a result wrapper. Each record has RespondentId and Date, demographic fields when present, and dynamic answer columns based on question order/type. The example shows selected metadata fields only; columns depend on the form. No data returns ErrorCode: ERROR with Errors containing No data found. There is no pagination or date filter on this route."
          }
        },
        {
          "name": "Download answers as Excel",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/survey/dataformat2/{{surveyId}}/false",
            "description": "Success returns an Excel attachment, not the JSON envelope. Inspect Content-Type / Content-Disposition before treating the body as a file: errors (including No data found) may be HTTP 200 JSON. No pagination or date filter."
          }
        }
      ]
    },
    {
      "name": "webhooks",
      "item": [
        {
          "name": "Create a webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/webhook/save",
            "description": "Creation only saves surveyId and webhookUrl. It starts with isWebhookOn: true, webhookSecret: \"\" and verifySSL: true. Configure other fields using Update a webhook. Returns the form creator’s webhook list. URLs must target public HTTP/HTTPS servers without embedded credentials; use HTTPS.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"surveyId\": \"{{surveyId}}\",\n  \"webhookUrl\": \"https://example.com/hooks/rapidoform\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Retrieve webhooks",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/webhook/info/{{surveyId}}",
            "description": "Requires access to the form’s workspace (or ownership of the form). Returns the form creator’s webhook list, consistently with creation. Member responses omit webhookSecret."
          }
        },
        {
          "name": "Update a webhook",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "url": "{{baseUrl}}/api/webhook/{{webhookId}}",
            "description": "Returns webhookInfo as one object, not an array. Send only the four documented mutable settings, using JSON booleans. Ownership/form IDs and update operators are rejected. URLs must be complete public HTTP/HTTPS URLs without embedded credentials. verifySSL controls HTTPS certificate verification for live, test and redelivery requests; keep it true. Store your signing secret in protected server configuration.",
            "body": {
              "mode": "raw",
              "raw": "{\n  \"webhookUrl\": \"https://example.com/hooks/rapidoform\",\n  \"isWebhookOn\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            }
          }
        },
        {
          "name": "Delete a webhook",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-EMAIL",
                "value": "{{email}}"
              },
              {
                "key": "X-API-KEY",
                "value": "{{apiKey}}"
              }
            ],
            "url": "{{baseUrl}}/api/webhook/{{webhookId}}",
            "description": "Returns a confirmation message, not the deleted webhook."
          }
        }
      ]
    }
  ]
}
