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>'

import requests

url = "https://spaces.nexudus.com/api/content/surveys/{id}"

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/surveys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<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 defines a questionnaire that can be delivered to customers on a schedule or triggered by specific events. Surveys support configurable delivery frequency and can target specific customer segments.

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 business linked to this record.

string

Display name of the linked business (read-only).

string

The name value for this survey.

string

Free-text description of this survey.

boolean

Whether this survey is currently active.

string

Date/time value for next delivery date.

integer

The delivery rate value for this survey.

integer

The delivery frequency value for this survey. See eSurveyDeliveryFrequency enum values: 1 = Weeks, 2 = Months, 3 = Years.

integer

The delivery rate maximum value for this survey.

integer

The delivery frequency maximum value for this survey. See eSurveyDeliveryFrequency enum values: 1 = Weeks, 2 = Months, 3 = Years.

string

Date/time value for start date.

string

ID of the scheduled job associated with this record.

boolean

Whether only for contacts is enabled.

boolean

Whether only for members is enabled.

integer[]

List of tariffs linked to this record.

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,
  "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 multiple SurveysRetrieve multiple Survey records by their Ids in a single request.

Get one Survey

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

import requests

url = "https://spaces.nexudus.com/api/content/surveys/{id}"

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/surveys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<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