Error Handling |
Determine what to return if an error is encountered. |
Space Slug |
The Space the submission is being retrieved from (defaults to info value if not provided). |
Kapp Slug |
The slug of the Kapp to search for submissions in. |
Form Slug |
The slug of the Form to search for submissions in. |
Include |
Comma-separated list of properties to include in the response. Options include 'details', 'activities', 'children', 'descendants', 'form', 'origin', 'parent', 'type', 'values', 'values.raw', and 'values[FIELD NAME]'. Note: Ignored if return type is ID List |
Core State |
Searches for submissions that have a core state that matches this parameter. Options are 'Draft', 'Submitted', 'Closed'. If no value is provided, the results will contain submissions in all core states. |
Timeline |
Date property to search by. Options are 'createdAt','submittedAt','updatedAt', and 'closedAt'. The default value is 'createdAt'. |
Direction |
Result Set sorting direction. Options are 'ASC' and 'DESC' The default value is descending (DESC). |
Start |
Start date/time of the timeline. This value should be used to both refine and limit the search results. Format: yyyy-MM-ddTHH:mm:ssZ |
End |
End date/time of the timeline. This value should be used to both refine and limit the search results. Format: yyyy-MM-ddTHH:mm:ssZ |
Limit |
Limit the number of results returned. If not provided, the server will limit the results to 25 submissions. Maximum value 1000. |
Query |
The query that will be used to search the submissions. Ex: values[Company]="Kinetic" |
Page Token |
The value to use as the offset for the page of submissions to return. The submission that matches this value will not be included in the results. |
Return Type |
The format that the results should be returned in. |