Retrieve Global Definitions

Sandbox Env

https://supplier-stage.surveysherpa.com

GET

/api/v1/getGlobalDefinitions/{fields}

This API lets suppliers get details of global definition fields. You can provide parameters like country, language, and others as comma-separated values in the request. At least one parameter must be included.

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://supplier-stage.surveysherpa.com/api/v1/getGlobalDefinitions/categories,questionType' \
--header 'x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NmUyOWUzMWE0MzRlNzUyYWRjZTgyMWMiLCJzdXBwbGllcl9pZCI6OCwiaWF0IjoxNzI2MTI3NjY1fQ.AuJsf6xCrSstkKUDHdsuX8PzJP08f5QINy0S_9i7V50'

Responses

🟢200Success

application/json

Body

Example

{
    "apiStatus": "Success",
    "result": {
        "countries": [
            {
                "name": "Afghanistan",
                "code": "AF"
            },
            {
                "name": "Argentina",
                "code": "AR"
            },
            {
                "name": "Austria",
                "code": "AT"
            },
            {
                "name": "India",
                "code": "IN"
            }
        ],
        "languages": [
            {
                "name": "ENGLISH"
            },
            {
                "name": "HINDI"
            },
            {
                "name": "HEBREW"
            },
            {
                "name": "FRENCH"
            }
        ],
        "deviceTypes": [
            "Mobile",
            "Desktop",
            "Tablet",
            "Mobile + Desktop",
            "Mobile + Tablet",
            "Desktop + Tablet",
            "All"
        ],
        "categories": [
            {
                "id": 1,
                "name": "Ailment"
            },
            {
                "id": 2,
                "name": "Automotive"
            },
            {
                "id": 3,
                "name": "Beauty/Cosmetics"
            }
        ],
        "surveyStatus": [
            {
                "0": "Pause",
                "1": "Live",
                "3": "Closed"
            }
        ],
        "questionTypes": [
            "Single Punch",
            "Multipunch",
            "Open End-Text",
            "Numeric Open Ended"
        ]
    }
}

Modified at 2025-08-20 05:34:10

Guides

Question Library Lookup