---
title: "Get Forms"
method: GET
path: "/gw/api/v1/forms"
tags: ["accountManagementUtilities"]
---

# Get Forms

`GET /gw/api/v1/forms`

Get forms<br><br>**Scope**: `accounts.read` OR `forms.read`<br>**Security Policy**: `HTTPS`

## Query parameters

- `formNo` integer[]
- `getDocs` string
- `fromDate` string
- `toDate` string
- `language` string
- `projection` 'PAYLOAD' | 'DOCS' | 'NONE'

## Response `200`

Get forms

- FormFileResponse
  - `error` ErrorResponse
    - `status` integer
    - `error` string
    - `message` string
  - `hasError` boolean
  - `errorDescription` string
  - `fileData` FileData
    - `data` FileDataData
    - `name` string
  - `formDetails` FormDetails[]
    - `formNumber` integer
    - `sha1Checksum` string
    - `dateModified` string, date-time
    - `fileName` string
    - `language` string
    - `formName` string
    - `payload` FormPayload
      - `mimeType` string
      - `data` string
    - `apiSupportedTask` boolean
    - `type` string
    - `action` string
    - `acceptableDocs` string[]
    - `questionnaire` QuestionnaireResponse[]
      - `questionId` integer
      - `question` string
      - `isMandatoryToAnswer` boolean
      - `questionType` string
      - `answers` AnswerResponse[]
        - `answerId` integer
        - `answer` string
        - `dependentQuestionId` integer
        - `dependentAnswerId` integer
        - `multiAnswerDetail` string[]
    - `error` ErrorResponse
      - `status` integer
      - `error` string
      - `message` string
    - `hasError` boolean
    - `errorDescription` string
    - `fileLength` integer
  - `timestamp` string, date-time

## Other responses

- `400` — Returns error description representing bad request
- `401` — Returns error description representing access issue
- `403` — Returns error description representing access issue
- `500` — Returns error description representing internal server error

---

[API](https://skmtc.net/interactivebrokers/apis/api-reference.md) · [All operations](https://skmtc.net/interactivebrokers/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/interactivebrokers/api-reference/revisions/67f9f562c2c6/schema)