Get Questionnaire Instance List

GET

/q/instance

Token scope Questionnaire Instance.List

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful Response

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.e-satisfaction.com/v3.2/q/instance' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filter_by": {
        "EQUAL": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "NOT_EQUAL": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "null": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "NOT_NULL": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "GREATER_THAN": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "LESS_THAN": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "GREATER_EQUAL": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "LESS_EQUAL": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "LIKE": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "NOT_LIKE": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "IN": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ],
        "NOT_IN": [
            {
                "COLUMN_NAME": "VALUE_NAME"
            }
        ]
    },
    "order_by": {
        "ASC": [
            "string"
        ],
        "DESC": [
            "string"
        ]
    },
    "pagination": {
        "page": 1,
        "max_per_page": 1,
        "include_results": true
    }
}'

Response Example

{
    "page": 0,
    "max_per_page": 0,
    "last_page": 0,
    "total_results": 0,
    "results": [
        {
            "instance_id": "string",
            "questionnaire_id": "string",
            "responder_id": "string",
            "locale": "string",
            "valid_days": 0,
            "editable": true,
            "finalized": true,
            "resolution_status": true,
            "analyzed": true,
            "viewed_time": "string",
            "viewed_time_ts": "string",
            "submitted_time": "string",
            "submitted_time_ts": "string",
            "completed_time": "string",
            "completed_time_ts": "string",
            "processed_time": "string",
            "processed_time_ts": "string",
            "flow_time": "string",
            "flow_time_ts": "string",
            "resolved_time": "string",
            "resolved_time_ts": "string",
            "last_analyzed_time": "string",
            "last_analyzed_time_ts": "string",
            "anonymized_time": "string",
            "anonymized_time_ts": "string",
            "resolved_by": "string",
            "responder": {
                "responder_id": "string",
                "organization_id": "string",
                "application_id": "string",
                "email": "string",
                "phone_number": "string",
                "first_name": "string",
                "last_name": "string",
                "metadata": [
                    {
                        "name": "string",
                        "value": "string",
                        "value_text": "string",
                        "value_number": 0,
                        "value_date": "string",
                        "value_boolean": true,
                        "original_value": "string"
                    }
                ],
                "created_time": "string",
                "updated_time": "string",
                "last_response_time": "string",
                "created_by": "string",
                "updated_by": "string"
            },
            "responses": [
                {
                    "question_id": "string",
                    "value": "string",
                    "question": {
                        "question_id": "string",
                        "template_question_id": "string",
                        "group_id": "string",
                        "type_id": "string",
                        "title": "string",
                        "description": "string",
                        "display_name": "string",
                        "required": true,
                        "enabled": true,
                        "fixed": true,
                        "display_order": 1,
                        "custom_values": "string",
                        "icon_url": "string",
                        "probability": 0,
                        "type": {
                            "type_id": "string",
                            "title": "string",
                            "description": "string"
                        },
                        "contents": [
                            {
                                "question_id": "string",
                                "locale": "string",
                                "title": "string",
                                "display_name": "string",
                                "description": "string"
                            }
                        ],
                        "values": [
                            {
                                "value_id": "string",
                                "question_id": "string",
                                "value": "string",
                                "title": "string",
                                "description": "string",
                                "contents": [
                                    {
                                        "value_id": "string",
                                        "locale": "string",
                                        "title": "string",
                                        "description": "string"
                                    }
                                ]
                            }
                        ]
                    }
                }
            ],
            "metadata_values": [
                {
                    "name": "string",
                    "value": "string",
                    "value_text": "string",
                    "value_number": 0,
                    "value_date": "string",
                    "value_boolean": true,
                    "original_value": "string"
                }
            ],
            "segments": [
                {
                    "segment_id": "string",
                    "title": "string"
                }
            ],
            "tags": [
                "string"
            ]
        }
    ]
}

Modified at 2026-03-20 06:13:10

Get Questionnaire Instance List with its children

Get Questionnaire Instance List by Organization