TrieOH
InformdAPIForms

Get the full form with answers

Returns the form with its steps, fields, and all submitted answers — the editing/analytics view. The actor must be a member of the form.

GET/forms/{form_id}/full

Returns the form with its steps, fields, and all submitted answers — the editing/analytics view. The actor must be a member of the form.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT issued by IdentityX, signed with Ed25519

In: header

Path Parameters

form_id*string

Form ID.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/forms/497f6eca-6276-4993-bfeb-53cbbbba6f08/full"
{
  "form": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "namespace_id": "be493771-41ca-4fe5-8001-a41a148c3359",
    "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "title": "string",
    "status": "draft",
    "opened_at": "2019-08-24T14:15:22Z",
    "closed_at": "2019-08-24T14:15:22Z",
    "archived_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "steps": [
    {
      "step": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
        "title": "string",
        "description": "string",
        "position_hint": 1
      },
      "fields": [
        {
          "field": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "step_id": "5cb19d54-1551-4ee7-a292-ee3ee4dcef77",
            "key": "string",
            "title": "string",
            "description": "string",
            "position_hint": 1,
            "required": true,
            "type": "string",
            "placeholder": {},
            "default_value": {},
            "config": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
          },
          "answers": [
            {
              "answer": {
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "response_id": "696f09c4-2678-4263-8db2-0a7204e502c2",
                "field_id": "e68e30b1-d177-4632-b748-463bcd0eedc6",
                "answer": {},
                "answered_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z"
              },
              "responder": "string"
            }
          ]
        }
      ]
    }
  ]
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 401,
  "title": "Unauthenticated"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 403,
  "title": "Insufficient Role"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 404,
  "title": "Not Found"
}
{
  "detail": "string",
  "instance": "../dictionary",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ],
  "type": "http://example.com",
  "status": 500,
  "title": "Internal Server Error"
}

Get the answerable view of a form GET

Returns the form with its steps and fields (no answers) for respondents to fill out. Public — this is the view embedded in the public submission flow. NOTE: the path keeps the original spelling `asnwerable`, which is part of the interface.

List form members GET

Lists the members of a form. The actor must be a member of the form.