# Get responses

URL: https://docs.hanzo.ai/docs/openapi/form/get-form-response

> Reads one response of a form.

`GET /v1/form/forms/{id}/responses/{response}`

> [Form →](https://docs.hanzo.ai/docs/openapi/form) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                                |
| ------------- | -------------------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/form/forms/{id}/responses/{response}` |
| **Method**    | `GET`                                                          |
| **Operation** | `get_form_response`                                            |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                         |

Reads one response of a form. An org admin only.

## Request

2 fields.

| Field      | In   | Type   | Required | Description                                   |
| ---------- | ---- | ------ | -------- | --------------------------------------------- |
| `id`       | path | string | yes      | ID is the form's id or slug, from the path.   |
| `response` | path | string | yes      | Response is the response's id, from the path. |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | form.Response   | ok      |
| `default` | problem-details | refused |

`200` body — 31 fields.

| Field                  | In   | Type            | Always | Description                                                                                                                                                                   |
| ---------------------- | ---- | --------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `answers`              | body | form.Answer\[]  | —      | Answers are the answers, in the form's field order.                                                                                                                           |
| `answers[].boolean`    | body | boolean         | —      |                                                                                                                                                                               |
| `answers[].choices`    | body | string\[]       | —      |                                                                                                                                                                               |
| `answers[].date`       | body | string          | —      |                                                                                                                                                                               |
| `answers[].field`      | body | string          | —      | Field is the ref of the field answered.                                                                                                                                       |
| `answers[].number`     | body | number (double) | —      |                                                                                                                                                                               |
| `answers[].text`       | body | string          | —      |                                                                                                                                                                               |
| `answers[].type`       | body | string          | —      | Type is the field's type.                                                                                                                                                     |
| `completed`            | body | boolean         | —      | Completed is whether the response was submitted whole; false is one saved part way.                                                                                           |
| `created`              | body | string          | —      | Created is when the record was first written, RFC 3339.                                                                                                                       |
| `duration`             | body | integer (int64) | —      | Duration is how many seconds lay between landing and submitting.                                                                                                              |
| `external`             | body | string          | —      | External is an imported response's id where it came from.                                                                                                                     |
| `filed`                | body | boolean         | —      | Filed is whether a completed response is on the CRM's timeline.                                                                                                               |
| `filing`               | body | string          | —      | Filing is why the last filing failed; empty once it is filed.                                                                                                                 |
| `form`                 | body | string          | —      | Form is the form's id.                                                                                                                                                        |
| `hidden`               | body | object          | —      | Hidden are the values the page passed in, by name.                                                                                                                            |
| `hidden.*`             | body | string          | —      |                                                                                                                                                                               |
| `id`                   | body | string          | —      | ID is the response's id: derived from the form and the submission's token (from the form and the address on a subscribe form), so a retried submission is this same response. |
| `landed_at`            | body | string          | —      | LandedAt is when the respondent opened the form, RFC 3339, as their page said.                                                                                                |
| `path`                 | body | string          | —      | Path is the page the form was answered on.                                                                                                                                    |
| `respondent`           | body | form.Respondent | —      |                                                                                                                                                                               |
| `respondent.email`     | body | string          | —      | Email is the address the response is from: the account's, else the email field's.                                                                                             |
| `respondent.kind`      | body | string          | —      | Kind is account (a signed-in person, from their token), email (an email field's answer), visitor (the page's visitor id) or none.                                             |
| `respondent.person_id` | body | string          | —      | PersonID is the CRM person the address is: the one key a response, a list membership, an email event and an experiment share.                                                 |
| `respondent.subject`   | body | string          | —      | Subject is the signed-in person's IAM subject.                                                                                                                                |
| `respondent.verified`  | body | boolean         | —      | Verified is whether the respondent is who the response says: true only for a signed-in person, from their token.                                                              |
| `respondent.visitor`   | body | string          | —      | Visitor is the page's visitor id.                                                                                                                                             |
| `source`               | body | string          | —      | Source is web, or import for a response brought in from elsewhere.                                                                                                            |
| `submitted_at`         | body | string          | —      | SubmittedAt is when the response was completed, RFC 3339.                                                                                                                     |
| `token`                | body | string          | —      | Token is the submission token the response was made under.                                                                                                                    |
| `updated`              | body | string          | —      | Updated is when it last changed, RFC 3339.                                                                                                                                    |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo form forms responses get <id> <response>
```

**SDK**

**.ts**

```ts
import { Configuration, FormApi } from 'hanzoai';

const api = new FormApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getFormResponse({ id: 'id', response: 'response' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FormApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FormApi(client).get_form_response(id='id', response='response')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.FormAPI.GetFormResponse(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, form_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = form_api::get_form_response(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FormApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new FormApi(client).getFormResponse();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl https://api.hanzo.ai/v1/form/forms/<id>/responses/<response> \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `form`, op `get_form_response` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "form",
         "arguments": {
           "op": "get_form_response",
           "input": {
             "id": "<id>",
             "response": "<response>"
           }
         }
       }
     }'
```

---

[Form API](https://docs.hanzo.ai/docs/openapi/form) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
