> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Lists a form's submitted responses, newest first.

> Cursor-paginated. Each response carries one answer per field that takes an answer, keyed
by the field's `Id` from the form detail; which of `TextValue`,
`NumberValue` and `OptionValues` is set follows the field's `Type`. Links
that were issued but never submitted are not responses and are not listed.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/forms/{formId}/responses
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/forms/{formId}/responses:
    get:
      tags:
        - Forms
      summary: Lists a form's submitted responses, newest first.
      description: "Cursor-paginated. Each response carries one answer per field that takes an answer, keyed\r\nby the field's `Id` from the form detail; which of `TextValue`,\r\n`NumberValue` and `OptionValues` is set follows the field's `Type`. Links\r\nthat were issued but never submitted are not responses and are not listed."
      operationId: get_v1_forms_formId_responses
      parameters:
        - name: formId
          in: path
          description: Form whose responses to list.
          required: true
          schema:
            pattern: ^[A-Za-z0-9_-]{1,50}$
            type: string
        - name: Cursor
          in: query
          description: >-
            Opaque pagination cursor from a previous page; omit for the first
            page.
          schema:
            type: string
        - name: PageSize
          in: query
          description: >-
            Number of items per page, 1-200 (default 50). Out of range is
            rejected, not clamped.
          schema:
            type: integer
            format: int32
            default: 50
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FormResponseListItemModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FormResponseListItemModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FormResponseListItemModelListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    FormResponseListItemModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/FormResponseListItemModel'
          nullable: true
        DataContext:
          $ref: '#/components/schemas/PaginationDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    FormResponseListItemModel:
      type: object
      properties:
        Id:
          type: string
          description: Response identifier.
        TicketId:
          type: string
          description: >-
            The ticket the form was submitted for, when it was sent from a
            ticket.
          format: uuid
          nullable: true
        TaskId:
          type: string
          description: The task the form was submitted for, when it was sent from a task.
          format: uuid
          nullable: true
        SubmittedAt:
          type: string
          description: When the response was submitted (UTC).
          format: date-time
        Answers:
          type: array
          items:
            $ref: '#/components/schemas/FormAnswerModel'
          description: >-
            The answers, one per field that takes an answer, in the form's
            display order.
      additionalProperties: false
      description: >-
        A submitted response to a form, as returned by the form responses
        endpoint.
    PaginationDataContext:
      type: object
      properties:
        Pagination:
          $ref: '#/components/schemas/PaginatedResponse'
      additionalProperties: false
      description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    FormAnswerModel:
      type: object
      properties:
        FieldId:
          type: string
          description: The field answered - the same `Id` the form detail lists.
        Label:
          type: string
          description: The question text at the time of submission.
        Type:
          type: string
          description: The input type answered, e.g. `Short_Answer`, `Checkbox`, `Date`.
        TextValue:
          type: string
          description: >-
            The answer as text. Dates are `yyyy-MM-dd`, times as typed (`4:30
            PM`).
          nullable: true
        NumberValue:
          type: number
          description: The answer to a `Number` field, when it parses as a number.
          format: double
          nullable: true
        OptionValues:
          type: array
          items:
            type: string
          description: >-
            The chosen option names - one for a multiple-choice, dropdown or
            toggle, any number for a checkbox.
          nullable: true
      additionalProperties: false
      description: "One answer. Exactly one of `TextValue`, `NumberValue` and\r\n`OptionValues` is set, according to the field type; all three are null when the\r\nrespondent left the field blank."
    PaginatedResponse:
      type: object
      properties:
        NextCursor:
          type: string
          nullable: true
        PreviousCursor:
          type: string
          nullable: true
        HasMore:
          type: boolean
        HasPrevious:
          type: boolean
        TotalCount:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.