Get list of questionnaires

Overview

Use this method to retrieve a list of all created questionnaires.

Request example

curl -X GET \
  'https://api.sumsub.com/resources/api/questionnaires/list'

Response explained

The response is a JSON object containing a list of all questionnaires.

The following is a root-level attribute:

FieldTypeDescription
listObjectIncludes data with items, totalItems.

list attributes

The following table explains the list attributes.

FieldTypeDescription
itemsArray of objectsEach item is an object representing a single questionnaire with its details.
totalItemsIntegerTotal number of all questionnaires.

items element fields

The following table explains the items element fields representing the questionnaire details.

FieldTypeDescription
idStringUnique entity identifier of the questionnaire. It is automatically assigned to the ID field during questionnaire creation and can be modified before the questionnaire is created. Used for most questionnaire-linked scenarios in the Dashboard.
titleStringQuestionnaire name. Empty ("") if not provided.
createdAtDateDate and time when the questionnaire was created, in the format yyyy-mm-dd HH:MM:SS (for example, 2025-11-05 13:38:31).

Response examples

If the request is sent and processed successfully, you will receive a response like the following:

{
    "list": {
        "items": [
            {
                "id": "questionnaire1",
                "title": "Default Questionnaire",
                "createdAt": "2025-11-05 13:38:31"
            },
            {
                "id": "questionnaire2",
                "title": "Advanced Questionnaire",
                "createdAt": "2025-11-05 13:37:42"
            },
            {
                "id": "questionnaire3",
                "title": "Individual Clients Questionnaire",
                "createdAt": "2025-11-05 13:35:52"
            }
        ],
        "totalItems": 3
    }
}

If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:

{
  "code": 403,
  "correlationId": "67c0b4b9034£920db5ee0£d9сc2a0d£c",
  "description": "You don't have this feature enabled, please contact us"
}
Language
Credentials
Header
Click Try It! to start a request and see the response here!