Get one Survey

GET

api

content

surveys

{id}

Get one Survey

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

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

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessWebAddress": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "Active": true,
  "NextDeliveryDate": "<string>",
  "DeliveryRate": 123,
  "DeliveryFrequency": 123,
  "DeliveryRateMaximum": 123,
  "DeliveryFrequencyMaximum": 123,
  "StartDate": "<string>",
  "ScheduledJobId": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the Survey record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/surveys/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/surveys/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/surveys/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location that owns this survey; the Admin Tool normally supplies it from the current location context.

string

Display value for Business.Name..

string

Display value for Business.WebAddress..

string

Required name used by administrators to identify this survey.

string

Required free-text description explaining the purpose of this survey.

boolean

Whether this survey is eligible for scheduled delivery when its next delivery date is due.

string

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

integer

Positive number of delivery-frequency units between scheduled deliveries; a value of zero prevents scheduled delivery.

integer

Unit used by DeliveryRate and the delivery cap: Weeks, Months, or Years; defaults to Weeks. See eSurveyDeliveryFrequency enum values: 1 = Weeks, 2 = Months, 3 = Years.

integer

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

integer

Legacy delivery-cap frequency setting; the delivery-cap calculation uses DeliveryFrequency, so manage the cap with DeliveryRateMaximum and DeliveryFrequency instead. See eSurveyDeliveryFrequency enum values: 1 = Weeks, 2 = Months, 3 = Years.

string

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

string

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

boolean

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

boolean

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

integer[]

List of plans eligible for member-only delivery; when OnlyForMembers is enabled, an empty list allows every member, otherwise the customer needs an active contract on one of these plans.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "BusinessName": null,
  "BusinessWebAddress": null,
  "Name": "",
  "Description": "",
  "Active": false,
  "NextDeliveryDate": "2025-01-15T10:30:00Z",
  "DeliveryRate": 0,
  "DeliveryFrequency": 0,
  "DeliveryRateMaximum": 0,
  "DeliveryFrequencyMaximum": 0,
  "StartDate": null,
  "ScheduledJobId": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "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
}

Get one Survey

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

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

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

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessWebAddress": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "Active": true,
  "NextDeliveryDate": "<string>",
  "DeliveryRate": 123,
  "DeliveryFrequency": 123,
  "DeliveryRateMaximum": 123,
  "DeliveryFrequencyMaximum": 123,
  "StartDate": "<string>",
  "ScheduledJobId": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200