v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Form Responses

This API endpoint retrieves all the responses (Pending & Completed) to a given form.

get/v1/forms/{id}/form-responses

Path parameters

idstring required

The ID of the form to retrieve the form responses for.

Query parameters

nextTokenstring

limitinteger

statusstring

Filter form responses by status. Options are pending or completed.

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "clientId": "d964f994-acb1-4859-81e5-c91c73b6ab12",
      "createdAt": "2024-02-12T23:26:30.97733477Z",
      "formFieldIds": [
        "47741982-6b81-4041-8063-d8f825259318"
      ],
      "formFields": {
        "09c8dc93-4532-4995-831e-4bdf1c2e437b": {
          "title": "Select your color scheme:",
          "description": "Color scheme description",
          "type": "multiSelect",
          "multipleChoiceOptions": [
            "Red"
          ],
          "answer": [
            "Green"
          ]
        },
        "2b7e3a5a-f335-430a-a8e9-8259c9f971d1": {
          "title": "Which industry are you in?",
          "description": "Industry description",
          "type": "singleSelect",
          "multipleChoiceOptions": [
            "Fashion"
          ],
          "answer": [
            "Social Media"
          ]
        },
        "425fa7b8-4446-4864-8542-d9a1bdd61991": {
          "title": "Assets Section",
          "description": "Describe and upload your brand assets.",
          "type": "title"
        },
        "47741982-6b81-4041-8063-d8f825259318": {
          "title": "What is your name?",
          "description": "Full name",
          "type": "shortAnswer",
          "answer": "Sample Client"
        },
        "7399360f-39f3-415f-af53-e223476b58eb": {
          "title": "Upload your logo(s) here:",
          "description": "File upload description",
          "type": "fileUpload",
          "answer": [
            "ElaineBenes.jpg"
          ],
          "attachmentUrls": [
            "https://ridebill-userfiles-mobilehub-310871815.s3-accelerate.amazonaws.com/protected/us-west-2%3A4a597750-5d36-4013-a36e-563c381632db/forms/28e7db81-35b0-4284-96f3-ae097dfdbdd2/7399360f-39f3-415f-af53-e223476b58eb/ElaineBenes.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQJQGUNGIZZRYXSXQ%2F20240212%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240212T235811Z&X-Amz-Expires=10800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEI7%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIH5xKSvQ%2B%2BMYgvOGWqcP2DPlcojvNBFXq0J5TPkyUZ5BAiEA44txywKJF1tpGeVYdaygkuNVxYko2IhHuoQNeGmhG9EqjQMIZxAGGgwwMjA0MTUwMTUzMTMiDExWm4rJuRxGnzl6xyrqApdlZuziYci3QZ1T9oE0htZYSszNMP3b6Swob6izc1zjD2VU7s8yWzRlJ%2BRVcTFpfMB%2FOKA%2FvkiG7N0zg5cDauQRFKmlX7643HlKFFepi3xtHz2uuYOvCzsKx7ESfDtvojoJxgLHLGuBIvw6118z9RAjHnKBMb9UIJpq8XhGyOycco8EaZoXJfjwZ4iuU4Ri97HYb2FXNCpeaSxaKJsOn%2BJx7FwDrkupguLrhyjsfuJgwGBXERA0nja43FsjVYzTOvS6%2F3LiJDqr6jPXTEHIqmc5mUiLaDN8MTxOqYeN%2BrDfvomwib7PU7gkIMsVbjhfImZklWwzC7CzvEnVhPToOKlcEboYsEiW1MwdHU3K5lQq2uuzGmLAynNu4FdZuQK%2Fspidtl%2FsIuTinNtcXxtlaJrRSCEbffKIh3FFbzHELORW4ah%2FXPK1jf92Nau6l%2BIeud45jS9fbJO6a1b4mA4ga7xXjSXYwahGff8DMIanqq4GOp0B2xv%2FXq71qxJfW%2FTzou5IyHuppXpZisYPfM9FM7oJN5R2LrRKjhDW7SUjbMFNzIw0TtvmOwyyg6uKmDbjljrCq1OwFCIwMzrT3Lq9%2FX4tDS%2FDBrVQD6NZdACZLNnUR1XgI0ciO%2BlD9ygrykzmmLS7ALI2EMlrB%2Bcq3C8XbhKjXvjvchEIlzTL2dcoZuShRIQBnW7WttytGaZ2vTuZGA%3D%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=8c1c062f5291959777545129dd21382308303b935371d5d2e4251bfd799bb3c3"
          ]
        },
        "a9da9a50-4196-4bc6-b6a3-345f33add0ef": {
          "title": "Describe your brand",
          "description": "Brand description",
          "type": "longAnswer",
          "answer": "A modern approach for social media posts and engagement."
        }
      },
      "formId": "28e7db81-35b0-4284-96f3-ae097dfdbdd2",
      "formName": "Sample Form All Question Types",
      "id": "zmQJbbhSR",
      "object": "formResponse",
      "status": "completed",
      "submissionDate": "2024-02-12T23:28:00.776964202Z",
      "visibility": "requestedClients"
    }
  ]
}