---
agentTools:
  projectIndex: https://dataforms.readme.io/llms.txt
---

# Index Data Forms

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "DataForms.io API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.dataforms.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/dataforms": {
      "get": {
        "summary": "Index Data Forms",
        "description": "",
        "operationId": "index-data-forms",
        "parameters": [
          {
            "name": "search",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"id\": \"form_YeyWL9rok76EjrE3JqBX28mlx\",\n            \"template_id\": \"templ_RpxGJNmGkN\",\n            \"headline\": \"Sample-Project 3\",\n            \"type\": \"collaborative\",\n            \"allow_multiple_submissions\": true,\n            \"lock_after_submission\": false,\n            \"url\": \"https://form.dataforms.io/YeyWL9rok76EjrE3JqBX28mlx\",\n            \"redirect_url\": null,\n            \"created_at\": \"2024-09-13T08:59:43+02:00\",\n            \"updated_at\": \"2024-09-13T09:48:19+02:00\"\n        },\n        {\n            \"id\": \"form_xmG0gPKXw7RQr6Q6pWlnYoLkO\",\n            \"template_id\": \"templ_RpxGJNmGkN\",\n            \"headline\": \"Musterformular 2\",\n            \"type\": \"standard\",\n            \"allow_multiple_submissions\": false,\n            \"lock_after_submission\": true,\n            \"url\": \"https://form.dataforms.io/xmG0gPKXw7RQr6Q6pWlnYoLkO\",\n            \"redirect_url\": null,\n            \"created_at\": \"2024-09-13T08:59:32+02:00\",\n            \"updated_at\": \"2024-09-13T08:59:32+02:00\"\n        }\n    ],\n    \"links\": {\n        \"first\": \"https://api.dataforms.io/dataforms?page=1\",\n        \"last\": \"https://api.dataforms.io/dataforms?page=1\",\n        \"prev\": null,\n        \"next\": null\n    },\n    \"meta\": {\n        \"current_page\": 1,\n        \"from\": 1,\n        \"last_page\": 1,\n        \"links\": [\n            {\n                \"url\": null,\n                \"label\": \"« Previous\",\n                \"active\": false\n            },\n            {\n                \"url\": \"https://api.dataforms.io/dataforms?page=1\",\n                \"label\": \"1\",\n                \"active\": true\n            },\n            {\n                \"url\": null,\n                \"label\": \"Next »\",\n                \"active\": false\n            }\n        ],\n        \"path\": \"https://api.dataforms.io/dataforms\",\n        \"per_page\": 10,\n        \"to\": 2,\n        \"total\": 2\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "form_YeyWL9rok76EjrE3JqBX28mlx"
                          },
                          "template_id": {
                            "type": "string",
                            "example": "templ_RpxGJNmGkN"
                          },
                          "headline": {
                            "type": "string",
                            "example": "Sample-Project 3"
                          },
                          "type": {
                            "type": "string",
                            "example": "collaborative"
                          },
                          "allow_multiple_submissions": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "lock_after_submission": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "url": {
                            "type": "string",
                            "example": "https://form.dataforms.io/YeyWL9rok76EjrE3JqBX28mlx"
                          },
                          "redirect_url": {},
                          "created_at": {
                            "type": "string",
                            "example": "2024-09-13T08:59:43+02:00"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2024-09-13T09:48:19+02:00"
                          }
                        }
                      }
                    },
                    "links": {
                      "type": "object",
                      "properties": {
                        "first": {
                          "type": "string",
                          "example": "https://api.dataforms.io/dataforms?page=1"
                        },
                        "last": {
                          "type": "string",
                          "example": "https://api.dataforms.io/dataforms?page=1"
                        },
                        "prev": {},
                        "next": {}
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "current_page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "from": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "last_page": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "links": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "url": {},
                              "label": {
                                "type": "string",
                                "example": "« Previous"
                              },
                              "active": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              }
                            }
                          }
                        },
                        "path": {
                          "type": "string",
                          "example": "https://api.dataforms.io/dataforms"
                        },
                        "per_page": {
                          "type": "integer",
                          "example": 10,
                          "default": 0
                        },
                        "to": {
                          "type": "integer",
                          "example": 2,
                          "default": 0
                        },
                        "total": {
                          "type": "integer",
                          "example": 2,
                          "default": 0
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "66e3d8b4130b6f004fcc958c:66e40e63509687005c3edee6"
}
```