Survey Availability Endpoint

Production Endpoint

https://supplier.innovatemr.net/api/v2

GET

/supply/getSurveyStatus/{surveyId}

This endpoint will return the current availability for the requested survey. If the 'available' property is true, then traffic can be sent to the survey. If it is false, traffic should not be sent. It is recommended to consult this endpoint before you route a respondent to a survey.

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.innovatemr.net/api/v2/supply/getSurveyStatus/' \
--header 'x-access-token;'

Responses

🟢200OK

application/json

Body

Example

{
    "apiStatus": "success",
    "msg": "Survey Availability status successfully fetched.",
    "result": {
        "surveyId": 12632,
        "available": true,
        "detail": "live"
    }
}

Modified at 2025-09-04 10:42:29

Get Panellist Profiling

Get Survey Stats data By Date Range