Forms

Get Form

Retrieve detailed information for a specific form by ID.

get/forms/{id}

Request

Path parameters

idinteger required
Example:123

Form ID

Response

Form retrieved successfully

Example response

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "forms",
    "id": "123",
    "attributes": {
      "title": "Contact Form",
      "form_setting": {
        "inputList": [
          {
            "type": "text",
            "label": "Name",
            "required": true
          }
        ]
      },
      "magnet_type": "DOWNLOAD",
      "magnet_url": "https://example.com/ebook.pdf",
      "magnet_file_src": "https://source.inblog.dev/files/ebook.pdf",
      "created_at": "2024-01-15T09:30:00Z",
      "response_count": 42
    },
    "relationships": {
      "form_responses": {
        "data": [
          {
            "type": "tags",
            "id": "123"
          }
        ]
      }
    }
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.