Skip to main content
GET
/
forms
/
{form_path}
Get Form
curl --request GET \
  --url https://api.decodahealth.com/forms/{form_path} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "id": "<string>",
  "name": "<string>",
  "patientId": "<string>",
  "blocks": [
    {
      "blockType": "DYNAMIC",
      "name": "<string>",
      "position": 123,
      "id": "<string>",
      "answers": [
        {
          "question": {
            "id": "<string>",
            "blockId": "<string>",
            "formId": "<string>",
            "position": 123,
            "questionType": "ADDRESS",
            "required": true,
            "data": {
              "name": "<string>",
              "description": "<string>"
            },
            "isArchived": false,
            "mappingKey": "<string>",
            "conditions": []
          },
          "data": "<string>"
        }
      ],
      "description": "<string>"
    }
  ],
  "description": "<string>",
  "completed": true,
  "isCompleted": false
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

form_path
string
required

Query Parameters

patient_id
string
required

Response

Successful Response

id
string
required
name
string
required
patientId
string | null
required
blocks
AnsweredBlockDetail · object[]
required
description
string | null
completed
boolean | null
isCompleted
boolean
default:false