List all form submissions

This endpoint provides a comprehensive list of form submissions, including detailed insights into what a user responded to a Vome form.

Endpoint and Request Method:

• GET /api/form-submissions/

• Access this endpoint to retrieve a paginated list of form submissions along with associated details.

1. Example Request:

   • GET https://api.vomevolunteer.com/api/form-submissions/

2. Authorization:

   • Requests to this endpoint require an API-KEY in the header for authentication.

headers = {
    "API-KEY": "your_unique_api_key_here"
}
response = requests.get("https://api.vomevolunteer.com/api/form-submissions/", headers=headers)

Response Structure::

{
    "count": 848,
    "next": "https://api.vomevolunteer.com/api/form-submissions/?page=2",
    "previous": null,
    "results": [
        {
            "id": "60c5e52b-e680-4b62-adc1-207e4ced130f",
            "user": {
                "id": "443f05ad-b1be-43bc-a213-3483471bc7fa",
                "first_name": "Lara",
                "last_name": "Smith",
                "email": "[email protected]",
                "gender": 0,
                "address": "2934 Thurlow Road, Hampstead, Montreal, QC, Canada",
                "phone_number": "929384838",
                "date_of_birth": "1973-03-04",
                "timezone": "America/Toronto",
                "address_coordinates": [
                    "45.4787326",
                    "-73.6406602"
                ]
            },
            "submission_status": "New",
            "created_at": "2024-10-30T21:19:53.069586Z",
            "arrival_source": {
                "id": "182e2f04-0d3c-4637-89a7-c6dbae95e90f",
                "category": {
                    "id": "c82cd6c8-0b5a-48af-853d-0a57e6954969",
                    "title": "Title of Category A",
                    "description": "Description of Category A"
                },
                "title": "Opportunity Title A",
                "description": "Description of Title A"
            },
            "questions": [
                {
                    "id": "6d51d684-70a0-4d3e-a5ef-db61025e03de",
                    "question": {
                        "id": "d56d80ac-7665-49bd-b7f1-ddd6873377bd",
                        "title": "If applicable, describe your previously involvement here.",
                        "question_type": "Text",
                        "options": []
                    },
                    "answer": "",
                    "options": [],
                    "responded": false
                },
                {
                    "id": "24666398-306d-4058-a058-50364af12c06",
                    "question": {
                        "id": "3a25e1ab-fb49-49d1-ab6a-690e03e5a5cd",
                        "title": "Which days of the week would you like to join us?",
                        "question_type": "Checkbox",
                        "options": [
                            "Thursday",
                            "Tuesday/Thurs",
                            "Friday"
                        ]
                    },
                    "answer": "",
                    "options": [
                        "Friday"
                    ],
                    "responded": true
                }
            ],
            "medical_info": null,
            "emergency_contact": {
                "name": "Daniel",
                "relationship": "Dad",
                "phone_number": "9389393898"
            },
            "digital_consent": [
                {
                    "id": "dc6a12a3-10da-49b7-bdf9-51514439f063",
                    "digital_consent_info": null,
                    "consent_status": 3 //Not provided
                }
            ],
            "general_availability": [
                {
                    "id": "7b8cca42-fcfd-4566-9715-7a9ec57132bf",
                    "day": 2, //Tuesday
                    "availability": "Morning"
                }
``          ],
            "attachments": [
                {
                    "id": "6c93e611-7e06-4aeb-9e30-fdad10126c2b",
                    "document_file": null,
                    "notes": "",
                    "attachment_info": {
                        "id": "854c5709-af07-49bd-b653-6a17154d192e",
                        "title": "Drivers License",
                        "description": ""
                    }
                }
            ],
            "opportunities": [
                {
                    "opportunity": {
                        "id": "6dd9de34-eee5-48dc-a684-edef63f7cd61",
                        "category": {
                            "id": "c82cd6c8-0b5a-48af-853d-0a57e6954969",
                            "title": "Category Title A",
                            "description": "Description of Category Title A"
                        },
                        "title": "Opportunity Title A",
                        "description": "Description of Opportunity Title A"
                    },
                    "opportunity_shifts_count": 1
                },
            ],
            "folder": {
                "name": "Basketball Program"
            },
            "form": {
                "id": "b4078162-9d3c-41fa-abbb-aada180c87d5",
                "title": "Form Title A"
            }
        },
    ]
}

The response provides a summary count and pagination details along with an array of submission records. Each record includes user information, submission status, question responses, consent details, availability, and any attachments.

Form Submissions Object Structure

• count (integer): Indicates the total number of form submissions available.

• next (string | null): Provides the URL to the next page of form submissions if more pages are available.

• previous (string | null): Provides the URL to the previous page of form submissions if applicable.

• results (array of Submission Detail Objects): Contains detailed information for each form submission entry.