Get Survey Custom Parameters

API Overview

• Function: Get survey custom parameters
• Request Method: GET
• Request URL: /api/surveys/{survey_id}/custom_args?appid={appid}&access_token={access_token}

Request Parameters

Parameter Name	Type	Location	Description	Example
survey_id	integer	uri	Survey ID	292192

Response Parameters

Parameter Name	Type	Description
total	integer	Total count
list	array[object]	Custom parameter list
list[_].id	string	Question ID
list[_].type	string	Type
list[_].title	string	Name

Response Examples

• Successful Request

{
    "code": "OK",
    "error": {
        "type": ""
    },
    "data": {
        "list": [
            {
                "id": "custom-arg-01",
                "type": "text",
                "title": "userid"
            }
        ],
        "total": 1
    },
    "request_id": "95wDdTkltedIpenc20240521153738"
}

• Failed Request

{
    "code": "InvalidArgument",
    "error": {
        "type": "invalid_argument",
    },
    "data": {},
    "request_id": "ddec96d2-165e-4f3e-8a64-2057db116983"
}

Error Codes

error.type Code	Description
claim_error	Permission Validation Error
survey_get_custom_args_validate	Parameter Validation Failed
survey_get_custom_args_failed	Failed to Get Custom Parameters