{"openapi":"3.0.0","info":{"description":"Forms and surveys","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Forms and surveys","url":"https://api.apirails.com/googleforms"}],"paths":{"/v1/forms":{"post":{"tags":["Forms"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms/create","api_endpoint":"https://forms.googleapis.com/v1/forms"},"summary":"Create a new form","description":"Create a new form using the title given in the provided form message in the request.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"info":{"type":"object","description":"This includes title and description of the form","required":true,"properties":{}}}},"example":{"info":{"documentTitle":"","title":""}}}}}}},"/v1/forms/{formId}":{"get":{"tags":["Forms"],"parameters":[{"name":"formId","in":"path","description":"The form ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms/get","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}"},"summary":"Get a form","description":"Get a form.","security":[{"bearerAuth":[]}]}},"/v1/forms/{formId}:batchUpdate":{"post":{"tags":["Forms"],"parameters":[{"name":"formId","in":"path","description":"The form ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms/batchUpdate","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}:batchUpdate"},"summary":"Batch update form","description":"Change the form with a batch of updates.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"includeFormInResponse":{"type":"boolean","description":"Whether to return an updated version of the model in the response","enum":[true,false]},"requests":{"type":"array","description":"The update requests of this batch","required":true,"items":{"type":"string"}},"writeControl":{"type":"object","description":"Provides control over how write requests are executed","properties":{}}}},"example":{"includeFormInResponse":true,"requests":[{"createItem":{},"deleteItem":{},"moveItem":{},"updateFormInfo":{},"updateItem":{},"updateSettings":{}}],"writeControl":{"requiredRevisionId":"","targetRevisionId":""}}}}}}},"/v1/forms/{formId}/responses":{"get":{"tags":["Forms Responses"],"parameters":[{"name":"formId","in":"path","description":"ID of the Form whose responses to list.","required":true,"schema":{"type":"string","example":""}},{"name":"filter","in":"query","description":"Which form responses to return. Currently the only supported filters are: timestamp > N (get all form responses submitted after timestamp N) and timestamp >= N (get all form responses submitted at and after timestamp N). Timestamp must be formatted in RFC3339 UTC \"Zulu\" format (e.g., \"2014-10-02T15:01:23Z\")","schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"The maximum number of responses to return. The service may return fewer than this value. If unspecified or zero, at most 5000 responses are returned.","schema":{"type":"number","example":""}},{"name":"pageToken","in":"query","description":"A page token returned by a previous list response. If this field is set, the form and the values of the filter must be the same as for the original request.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms.responses/list","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}/responses"},"summary":"List form responses","description":"List a form's responses.","security":[{"bearerAuth":[]}]}},"/v1/forms/{formId}/responses/{responseId}":{"get":{"tags":["Forms Responses"],"parameters":[{"name":"formId","in":"path","description":"The form ID","required":true,"schema":{"type":"string","example":""}},{"name":"responseId","in":"path","description":"The response ID within the form","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms.responses/get","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}/responses/{responseId}"},"summary":"Get form response","description":"Get one response from the form.","security":[{"bearerAuth":[]}]}},"/v1/forms/{formId}/watches":{"get":{"tags":["Forms Watches"],"parameters":[{"name":"formId","in":"path","description":"ID of the Form whose watches to list.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms.watches/list","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}/watches"},"summary":"List form watches","description":"Return a list of the watches owned by the invoking project.","security":[{"bearerAuth":[]}]},"post":{"tags":["Forms Watches"],"parameters":[{"name":"formId","in":"path","description":"ID of the Form to watch.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms.watches/create","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}/watches"},"summary":"Create form watch","description":"Create a new watch.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"watch":{"type":"object","description":"The watch object. No ID should be set on this object","required":true,"properties":{}},"watchId":{"type":"string","description":"The ID to use for the watch"}}},"example":{"watch":{"createTime":"","errorType":"","eventType":"","expireTime":"","state":"","target":{"topic":{"topicName":""}}},"watchId":""}}}}}},"/v1/forms/{formId}/watches/{watchId}":{"delete":{"tags":["Forms Watches"],"parameters":[{"name":"formId","in":"path","description":"The ID of the Form.","required":true,"schema":{"type":"string","example":""}},{"name":"watchId","in":"path","description":"The ID of the Watch to delete.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms.watches/delete","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}/watches/{watchId}"},"summary":"Delete form watch","description":"Delete a watch.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/forms/{formId}/watches/{watchId}:renew":{"post":{"tags":["Forms Watches"],"parameters":[{"name":"formId","in":"path","description":"The ID of the Form","required":true,"schema":{"type":"string","example":""}},{"name":"watchId","in":"path","description":"The ID of the Watch to renew","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms.watches/renew","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}/watches/{watchId}:renew"},"summary":"Renew form watch","description":"Renew an existing watch for seven days.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/v1/forms/{formId}:setPublishSettings":{"post":{"tags":["Forms"],"parameters":[{"name":"formId","in":"path","description":"The form ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.google.com/forms/api/reference/rest/v1/forms/setPublishSettings","api_endpoint":"https://forms.googleapis.com/v1/forms/{formId}:setPublishSettings"},"summary":"Set form publish settings","description":"Update the publish settings of a form.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"publishSettings":{"type":"object","description":"The publish settings for the form","required":true,"properties":{}}}},"example":{"publishSettings":{"allowResponses":true,"publishToDomain":false,"publishToWeb":false,"requireLogin":false}}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}