Search Surveys

Search and list Survey records with filtering, sorting, and pagination.

GET /api/content/surveys

Search Surveys

cURL

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

200

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

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

Enums

eSurveyDeliveryFrequency — DeliveryFrequency values

Value	Name
1	Weeks
2	Months
3	Years

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

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

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

Survey_Business · integer

Filter by iD of the business linked to this record.

Survey_Business_Name · string

Filter by display name of the linked business (read-only).

Survey_Name · string

Filter by the name value for this survey.

Survey_Description · string

Filter by free-text description of this survey.

Survey_Active · boolean

Filter by whether this survey is currently active.

Survey_NextDeliveryDate · string

Filter by date/time value for next delivery date.

Survey_DeliveryRate · integer

Filter by the delivery rate value for this survey.

Survey_DeliveryFrequency · integer

Filter by the delivery frequency value for this survey.

Survey_DeliveryRateMaximum · integer

Filter by the delivery rate maximum value for this survey.

Survey_DeliveryFrequencyMaximum · integer

Filter by the delivery frequency maximum value for this survey.

Survey_StartDate · string

Filter by date/time value for start date.

Survey_ScheduledJobId · string

Filter by iD of the scheduled job associated with this record.

Survey_OnlyForContacts · boolean

Filter by whether only for contacts is enabled.

Survey_OnlyForMembers · boolean

Filter by whether only for members is enabled.

Range Filters

from_Survey_NextDeliveryDate · string

Filter by date/time value for next delivery date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Survey_NextDeliveryDate · string

Filter by date/time value for next delivery date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Survey_DeliveryRate · integer

Filter by the delivery rate value for this survey greater than or equal to this value.

to_Survey_DeliveryRate · integer

Filter by the delivery rate value for this survey less than or equal to this value.

from_Survey_DeliveryRateMaximum · integer

Filter by the delivery rate maximum value for this survey greater than or equal to this value.

to_Survey_DeliveryRateMaximum · integer

Filter by the delivery rate maximum value for this survey less than or equal to this value.

from_Survey_StartDate · string

Filter by date/time value for start date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_Survey_StartDate · string

Filter by date/time value for start date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_Survey_CreatedOn · string

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

to_Survey_CreatedOn · string

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

from_Survey_UpdatedOn · string

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

to_Survey_UpdatedOn · string

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

Code Examples

Simple listing

cURL

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

Filtering by Name

cURL

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

Range filters

cURL

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"

Response

200

Records · 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: DeliveryFrequency, 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.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

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

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "Name": "",
      "Description": "",
      "Active": false,
      "NextDeliveryDate": "2025-01-15T10:30:00Z",
      "DeliveryRate": 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": "[e-mail]",
      "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
}