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.
created_at.gt (string, ISO-8601): Filters by created_at > value (strictly after).
created_at.gte (string, ISO-8601): Filters by created_at >= value.
created_at.lte (string, ISO-8601): Filters by created_at <= value.
created_at.lt (string, ISO-8601): Filters by created_at < value (strictly before).
# 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
# created_at.gte
GET /api/form-submissions/search/?created_at.gte=2024-09-06T02:57:15.008656Z
# created_at.gt
GET /api/form-submissions/search/?created_at.gt=2024-09-06T02:57:15.008656Z
# created_at.lte
GET /api/form-submissions/search/?created_at.lte=2024-09-06T02:57:15.008656Z
# created_at.lt
GET /api/form-submissions/search/?created_at.lt=2026-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
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.
Form filters
• form.id: Filters form submissions by the form ID.
• form.title: Filters form submissions by the form title.
Sample Request:
Folder filters
• folder.name: Filters form submissions by the folder name.
Sample Request:
Authorization:
Requests must include an API key in the header for authentication.
Response Structure:
Example Response Object:
Last updated