v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Retrieve Form

This API endpoint retrieves a specific form.

get/v1/forms/{id}

Path parameters

idstring required

The unique ID of the form to retrieve.

Response

200

idstring
createdAtstring
objectstring
namestring
descriptionstring
formFieldIdsstring[]
allowMultipleSubmissionsboolean
visibilitystring
formResponseRequestsinteger
formResponseSubmissionsinteger
latestSubmissionDatestring
updatedAtstring

Example response

{
  "id": "a8c2c520-8045-4068-1772-a7c8ca09ee1a",
  "createdAt": "2023-02-25T02:19:35Z",
  "object": "form",
  "name": "Onboarding Form",
  "description": "Fill out this form to get started!",
  "formFieldIds": [
    "id0"
  ],
  "formFields": [
    {
      "formFieldId": "id0",
      "title": "Welcome to Potluck's Accounting Services!",
      "description": "Email me if you have any questions at potluck@copilot.app",
      "type": "title"
    }
  ],
  "visibility": "allClients",
  "formResponseRequests": 3,
  "formResponseSubmissions": 8,
  "latestSubmissionDate": "2023-05-25T02:19:35Z"
}