Skip to main content
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>'
{
  "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

​
id
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"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
BusinessName
string
Display name of the linked business (read-only).
​
Name
string
The name value for this survey.
​
Description
string
Free-text description of this survey.
​
Active
boolean
Whether this survey is currently active.
​
NextDeliveryDate
string
Date/time value for next delivery date.
​
DeliveryRate
integer
The delivery rate value for this survey.
​
DeliveryFrequency
integer
The delivery frequency value for this survey. See eSurveyDeliveryFrequency enum values: 1 = Weeks, 2 = Months, 3 = Years.
​
DeliveryRateMaximum
integer
The delivery rate maximum value for this survey.
​
DeliveryFrequencyMaximum
integer
The delivery frequency maximum value for this survey. See eSurveyDeliveryFrequency enum values: 1 = Weeks, 2 = Months, 3 = Years.
​
StartDate
string
Date/time value for start date.
​
ScheduledJobId
string
ID of the scheduled job associated with this record.
​
OnlyForContacts
boolean
Whether only for contacts is enabled.
​
OnlyForMembers
boolean
Whether only for members is enabled.
​
Tariffs
integer[]
List of tariffs linked to this record.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}