DAdatadog
Forms

Get a form

Get a form definition by its ID.

get/api/v2/forms/{form_id}

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v2/forms/{form_id}
  • Auth
    API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY

Path parameters

form_idstring uuid required

The ID of the form.

Query parameters

versionstring

The version of the form to retrieve. Use 'latest' for the most recent draft, 'published' for the last published version, or a specific version number.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "active": true,
      "created_at": "2026-05-29T20:06:13.677353Z",
      "datastore_config": {
        "datastore_id": "5108ea24-dd83-4696-9caa-f069f73d0fad",
        "primary_column_name": "id",
        "primary_key_generation_strategy": "none"
      },
      "description": "A form to collect user feedback.",
      "modified_at": "2026-05-29T20:06:13.677353Z",
      "name": "User Feedback Form",
      "org_id": 2,
      "publication": {
        "created_at": "2026-05-29T20:06:13.677353Z",
        "form_id": "afc67600-0511-43b1-9b18-578fb4979bd3",
        "form_version": 1,
        "id": "42",
        "modified_at": "2026-05-29T20:06:13.677353Z",
        "org_id": 2,
        "publish_seq": 1,
        "user_id": 10001,
        "user_uuid": "1fc709aa-be19-4539-a47d-52a30d78a978"
      },
      "user_id": 10001,
      "user_uuid": "1fc709aa-be19-4539-a47d-52a30d78a978",
      "version": {
        "created_at": "2026-05-29T20:06:14.895921Z",
        "data_definition": {
          "description": "Welcome to the Engineering Experience Survey.",
          "title": "Developer Experience Survey"
        },
        "definition_signature": "{\"signature\":\"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545\",\"version\":1}",
        "etag": "b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d",
        "id": "126",
        "modified_at": "2026-05-29T20:06:14.949163Z",
        "state": "frozen",
        "user_id": 10001,
        "user_uuid": "1fc709aa-be19-4539-a47d-52a30d78a978",
        "version": 1
      }
    },
    "id": "22f6006a-2302-4926-9396-d2dfcf7b0b34",
    "type": "forms"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.