Search Surveys

GET

api

content

surveys

Search Surveys

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

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

fetch('https://spaces.nexudus.com/api/content/surveys', 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 (Survey) is a location-specific questionnaire sent to selected customers on a recurring schedule. It defines delivery timing, customer eligibility, and the questions customers can answer.

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 Survey-List role.

Enums

eSurveyDeliveryFrequency — DeliveryFrequency values

Value	Name
1	Weeks
2	Months
3	Years

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 location that owns this survey; the Admin Tool normally supplies it from the current location context.

string

Filter by display value for Business.Name..

string

Filter by display value for Business.WebAddress..

string

Filter by required name used by administrators to identify this survey.

string

Filter by required free-text description explaining the purpose of this survey.

boolean

Filter by whether this survey is eligible for scheduled delivery when its next delivery date is due.

string

Filter by uTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery.

integer

Filter by positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery.

integer

Filter by unit used by DeliveryRate and the delivery cap: Weeks, Months, or Years; defaults to Weeks.

integer

Filter by maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date.

integer

Filter by legacy delivery-cap frequency setting; the delivery-cap calculation uses DeliveryFrequency, so manage the cap with DeliveryRateMaximum and DeliveryFrequency instead.

string

Filter by optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply.

string

Filter by system-managed scheduler job ID while a delivery is queued; it is cleared after delivery and must never be set by an agent.

boolean

Filter by whether delivery is restricted to contacts without an active contract; when enabled with OnlyForMembers, both restrictions apply and no customer can qualify.

boolean

Filter by whether delivery is restricted to members with an active contract; when Tariffs is non-empty, the contract must be on one of those plans.

Range Filters

string

Filter by uTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC date and time when the next scheduled delivery is due; the system advances it by the delivery rate after a delivery less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery greater than or equal to this value.

integer

Filter by positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery less than or equal to this value.

integer

Filter by maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date greater than or equal to this value.

integer

Filter by maximum number of DeliveryFrequency units after StartDate for scheduled deliveries; zero means no end date less than or equal to this value.

string

Filter by optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time from which the delivery cap is measured; without it, the delivery cap does not apply less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/surveys?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by Name

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/content/surveys?' + new URLSearchParams({
    from_Survey_UpdatedOn: '2025-01-01T00:00',
    to_Survey_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/surveys',
    params={
        'from_Survey_UpdatedOn': '2025-01-01T00:00',
        'to_Survey_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

Survey[]

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

Partial records — The listing endpoint returns a summary representation of each Survey. The following fields are not populated in the Records[] response: DeliveryFrequencyMaximum, OnlyForContacts, OnlyForMembers.To get all fields, fetch the full record using the Get one Survey endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

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": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessWebAddress": null,
      "Name": "",
      "Description": "",
      "Active": false,
      "NextDeliveryDate": "2025-01-15T10:30:00Z",
      "DeliveryRate": 0,
      "DeliveryFrequency": 0,
      "DeliveryRateMaximum": 0,
      "StartDate": null,
      "ScheduledJobId": null,
      "Tariffs": [],
      "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": "Survey Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search Surveys

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

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

fetch('https://spaces.nexudus.com/api/content/surveys', 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 Name

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200