v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

List Forms

This API endpoint retrieves a list of forms.

get/v1/forms

Query parameters

nextTokenstring
limitinteger

Response

200

nextTokenstring

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "nextToken": "eyJwa2V5IjoiYTAzOWIyMjgtMjc0NS00YTJiLWJjZjctYWFjNTZkNjUxOWJmIiwic2tleSI6IklOVEFLRV9GT1JNX1RFTVBMQVRFIiwiZGF0YSI6InVzLWVhc3QtMV9xbEFSQlE5bUYvZGVmYXVsdC9iMTRlZmJlOC03Y2U3LTRjNDEtYTdhNC0yMzczMTNmYzgxZDMifQ=="
}