Search SurveyQuestions

GET

api

content

surveyquestions

curl --request GET \
  --url https://spaces.nexudus.com/api/content/surveyquestions \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/surveyquestions"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/surveyquestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A survey question (SurveyQuestion) is an ordered question within a location’s customer survey. It defines the customer-facing label, explanation, input type, optional choices, and whether the question is shown.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the SurveyQuestion-List role.

Enums

eQuestionType — QuestionType values

Value	Name
1	Text
2	Boolean
3	LongText
4	Date
5	Dropdown
6	Binary

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the survey that contains this question; the survey’s location determines access to the question.

string

Filter by display value for Survey.Name..

string

Filter by required question label shown to customers.

string

Filter by required explanatory text shown below the question to customers.

string

Filter by comma-separated choices for a Dropdown question; leave empty for other question types.

boolean

Filter by whether this question appears in the customer-facing survey.

integer

Filter by integer position for displaying this question; lower values appear first and the system renumbers questions after create or update.

boolean

Filter by whether customers can select more than one choice for a Dropdown question.

integer

Filter by controls the customer input: Text, Boolean (Yes/No), LongText, Date, Dropdown, or Binary file upload; defaults to Text.

Range Filters

integer

Filter by integer position for displaying this question; lower values appear first and the system renumbers questions after create or update greater than or equal to this value.

integer

Filter by integer position for displaying this question; lower values appear first and the system renumbers questions after create or update less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/surveyquestions?page=1&size=15&orderBy=Text&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/surveyquestions?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Text',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/surveyquestions',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Text',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Text

curl -X GET \
  "https://spaces.nexudus.com/api/content/surveyquestions?SurveyQuestion_Text=example-value&orderBy=Text&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/surveyquestions?' + new URLSearchParams({
    SurveyQuestion_Text: 'example-value',
    orderBy: 'Text',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/surveyquestions',
    params={
        'SurveyQuestion_Text': 'example-value',
        'orderBy': 'Text',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/surveyquestions?from_SurveyQuestion_UpdatedOn=2025-01-01T00:00&to_SurveyQuestion_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/surveyquestions?' + new URLSearchParams({
    from_SurveyQuestion_UpdatedOn: '2025-01-01T00:00',
    to_SurveyQuestion_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/surveyquestions',
    params={
        'from_SurveyQuestion_UpdatedOn': '2025-01-01T00:00',
        'to_SurveyQuestion_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

SurveyQuestion[]

The list of SurveyQuestion records matching the query. See the Get one SurveyQuestion endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "SurveyId": 0,
      "SurveyName": null,
      "Text": "",
      "Description": "",
      "AvailableOptions": null,
      "Active": false,
      "DisplayOrder": 0,
      "AllowMultipleOptions": false,
      "QuestionType": 0,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "SurveyQuestion Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Text",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search SurveyQuestions

curl --request GET \
  --url https://spaces.nexudus.com/api/content/surveyquestions \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/surveyquestions"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/surveyquestions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Text

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Text

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Text

Range filters

Response

200