Loading ...

REST API: Get Survey | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Polls and Surveys » REST API: Get Survey
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 25

REST API: Get Survey

0 
 /5
0 (0votes)
Open API Guide
GET/api/surveys/{SurveyID}

Enables administrators and developers to programmatically retrieve a specific survey.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
SurveyIDIntegerYESPathUnique ID for a survey

Optional Parameters

ParameterTypeRequiredLocationDescription
LogViewBooleanNOQueryLogs the API call as an action in User Activity when set to true

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/surveys/145

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "PollID": 117,
    "Question": "Team Survey",
    "SurveyTitle": "Team Survey",
    "UserName": "jane.doe",
    "IsLatest": false,
    "IsSurvey": true,
    "DateClose": "2025-03-26T17:52:33.213",
    "CreatedBy": 42,
    "Votes": 0,
    "DateCreated": "2025-03-26T17:52:33.213",
    "SpaceID": 0,
    "SpaceName": "",
    "MediaServerID": 90,
    "SurveyImageFileName": "",
    "AllowSurveyRetake": false,
    "PollUrl": "https://your-site.com/surveys/117/team-survey",
    "UserProfileURL": "https://your-site.com/people/jane.doe",
    "UserDisplayName": "Jane Doe",
    "UserAvatarFullUrl": "https://your-site.com/Assets/Uploaded-Photos/42/avatar.jpg",
    "DateTimeSpan": "3/26/2025",
    "SurveyImageUrl": "https://your-site.com/assets/Themes/default/images/survey-default.gif",
    "CurrentUserChoiceID": 0,
    "PollQuestions": [
      {
        "QuestionID": 125,
        "QuestionText": "What is your favorite color?",
        "PollID": 117,
        "SortOrder": 1,
        "InputControlType": 0,
        "InputControlTypeInt": 0,
        "Choices": [
          {
            "ChoiceID": 271,
            "PollID": 117,
            "QuestionID": 125,
            "Points": 0,
            "UserID": 0,
            "Choice": "Yellow",
            "Votes": 0,
            "PollQuestionInputControlType": 0,
            "SortOrder": 1,
            "ChoiceImageFileName": "",
            "TenantID": 0
          },
          {
            "ChoiceID": 272,
            "PollID": 117,
            "QuestionID": 125,
            "Points": 0,
            "UserID": 0,
            "Choice": "Green",
            "Votes": 0,
            "PollQuestionInputControlType": 0,
            "SortOrder": 2,
            "ChoiceImageFileName": "",
            "TenantID": 0
          }
        ],
        "TenantID": 0
      }
    ],
    "EntityID": 0,
    "SurveyTestMode": false,
    "HasUserVotedForSurvey": false,
    "IsAnonymous": false,
    "TenantID": 1
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestSurveyID in the path is not an integer.Send the survey's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
200 with ResponseData nullNo survey has that ID, or SurveyID is 0.Check the SurveyID.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages