SOsoraban
Questionnaires

List questionnaires

Changed on
get/questionnaires

Request

Query parameters

tax_yearinteger
Example:2025

Only questionnaires for this tax year.

entity_idinteger

Only questionnaires for this entity.

pageinteger

1-based page number.

per_pageinteger

Results per page.

Response

A page of questionnaires. sections is empty for locked questionnaires.

idinteger
company_idinteger
namestring nullable
formatted_namestring nullable
tax_yearinteger nullable
statusstring nullable

Null when the questionnaire has been sent but not yet opened.

completedboolean nullable
lockedboolean nullable
is_draftboolean nullable
is_open_itemboolean nullable
in_progressboolean nullable
processingboolean nullable
due_datestring date nullable
sent_atstring date-time nullable
submitted_atstring date-time nullable
opened_timestampstring date-time nullable
updated_at_by_clientstring date-time nullable
first_doc_uploaded_atstring date-time nullable
last_followed_upstring date-time nullable
last_activitystring date-time nullable
created_atstring date-time
updated_atstring date-time
deleted_atstring date-time nullable
document_pathstring nullable
documents_neededobject[]

Empty for locked or completed questionnaires.

document_count_answeredinteger nullable
document_count_totalinteger nullable
note_countinteger nullable
sectionsobject[]

Empty for locked questionnaires.

Changes

  • 1c230fa547adRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      api operation id listQuestionnaires was added

    • info

      the endpoint scheme security bearerAuth was removed from the API

    • info

      api tag Questionnaires added

    • info

      removed the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status