Responses

List form responses

Retrieves all completed and in-progress responses for a form. Requires ANALYZE permission or ownership of responses.

get/forms/{formId}/responses

Query parameters

status'draft' | 'completed' | 'edited'
sort'started' | 'submitted' | 'edited'

Sort criteria.

order'asc' | 'desc'
limitinteger
offsetinteger

Response

List of form responses.

idstring required
formstring ulid required
respondentstring ulid nullable
status'draft' | 'completed' | 'edited' required
startedstring date-time required
submittedstring date-time nullable
editedstring date-time nullable

Changes

Changed in 4 of the 14 revisions of this API.910

    • added the new enum value edited to the query request parameter sort

      request-parameter-enum-value-added

    • added the new optional query request parameter limit

      new-optional-request-parameter

    • added the new optional query request parameter offset

      new-optional-request-parameter

    • added the new optional query request parameter order

      new-optional-request-parameter

    • added the new optional query request parameter sort

      new-optional-request-parameter

    • added the new optional query request parameter status

      new-optional-request-parameter

    • added the optional property items/edited to the response with the 200 status

      response-optional-property-added

  • de597e8f26bc21See the full diff
    • added the new draft enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • added the new edited enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • removed the in_progress enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

  • 0d7f3c75097972See the full diff
    • deleted the query request parameter limit

      request-parameter-removed

    • deleted the query request parameter offset

      request-parameter-removed

    • deleted the query request parameter order

      request-parameter-removed

    • deleted the query request parameter sort

      request-parameter-removed

    • deleted the query request parameter status

      request-parameter-removed

    • removed the optional property items/edited from the response with the 200 status

      response-optional-property-removed

    • added the new in_progress enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • removed the draft enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the edited enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog