Search form submissions

This endpoint allows you to query and retrieve form submissions based on user-specified criteria such as an email address or an answer to a question. This functionality is essential for filtering and efficiently managing large datasets of form submissions.​

Endpoint Description:

• Endpoint: GET /api/form-submissions/

• Base URL: https://api.vomevolunteer.com

Query Parameters:

Core Filters

• id (uuid): Filters form submissions by the ID.

• created_at (string): Filters form submissions by the created_at.

# id
GET /api/form-submissions/search/?id=6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7

# created_at
GET /api/form-submissions/search/?created_at=2024-09-06T02:57:15.008656Z

Question filters

• question.id (string): Filters form submissions by the question ID.

• question.answer (string): Filters form submissions by the answers

GET /api/form-submissions/search/?question.id=6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7&answer=NO

User Filters

• user.id (uuid): Filters form submissions by the ID.

• user.first_name: (string): Filters form submissions by the user's first name.

• user.last_name: (string): Filters form submissions by the user's last name.

• user.email (string): Searches for form submissions associated with a specific email address.

# id
GET /api/form-submissions/search/?user.id=6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7

# first_name
GET /api/form-submissions/search/?user.first_name=Aaron

# last_name
GET /api/form-submissions/search/?user.last_name=James

# email
GET /api/form-submissions/search/[email protected]

Form filters

• form.id: Filters form submissions by the form ID.

• form.title: Filters form submissions by the form title.

Sample Request:

# id
GET /api/form-submissions/search/?form.id=6e84d2e9-ceb2-4b58-9bfb-97f49dd267e7

# title
GET /api/form-submissions/search/?form.title=FormTitleA

Folder filters

• folder.name: Filters form submissions by the folder name.

Sample Request:

# folder
GET /api/form-submissions/search/?folder.name=FolderName1

Authorization:

Requests must include 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/[email protected]", headers=headers)

Response Structure:

Example Response Object:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "04a1dcec-eefb-4faf-a7b6-d66b59784a4d",
            "user": {
                "id": "48d1173e-17e4-408e-a114-5e50581cf4e5",
                "first_name": "Stephanie",
                "last_name": "Lily",
                "email": "[email protected]",
                "gender": null,
                "address": "",
                "phone_number": "3434343243",
                "date_of_birth": null,
                "timezone": "America/Toronto",
                "address_coordinates": null
            },
            "submission_status": "New",
            "created_at": "2024-09-18T17:08:34.046225Z",
            "arrival_source": null,
            "questions": [],
            "medical_info": null,
            "emergency_contact": null,
            "digital_consent": [],
            "general_availability": [],
            "attachments": [],
            "opportunities": [],
            "folder": {
                "name": "Volleyball Program"
            },
            "form": {
                "id": "7d5b83eb-adf0-4920-8fb4-894a71d4a0c5",
                "title": "Test Form 19"
            }
        }
    ]
}