---
updatedAt: 2026-06-09T16:19:20.000Z
agentTools:
  projectIndex: https://docs.smartsurvey.io/llms.txt
---

# Get By Id

Gets the basic information about a single survey, including the folder it is filed in. folder_id is 0 when the survey is not in a folder, and also 0 for a survey shared with you by another account, because a survey's folder belongs to its owner.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "SS Public API",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://{host}/v2",
      "description": "Select the host for the region your account's data is stored in.",
      "variables": {
        "host": {
          "default": "api.smartsurvey.io",
          "description": "The regional hostname for your account.",
          "enum": [
            "api.smartsurvey.io",
            "api-eu.smartsurvey.io",
            "api-us.smartsurvey.io"
          ]
        }
      }
    }
  ],
  "paths": {
    "/surveys/{surveyId}": {
      "get": {
        "tags": [
          "Surveys"
        ],
        "summary": "Get By Id",
        "description": "Gets the basic information about a single survey, including the folder it is filed in. folder_id is 0 when the survey is not in a folder, and also 0 for a survey shared with you by another account, because a survey's folder belongs to its owner.",
        "parameters": [
          {
            "name": "surveyId",
            "in": "path",
            "description": "The survey id of the survey to fetch",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "translation_id",
            "in": "query",
            "description": "The id of the translation you want the details in or 0 for the default",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.Surveys.SurveySingleResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.Surveys.SurveySingleResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.Surveys.SurveySingleResponse"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.Surveys.SurveySingleResponse"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.Surveys.SurveySingleResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Survey not found",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Microsoft.AspNetCore.Mvc.ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when\r\ndereferenced, it provide human-readable documentation for the problem type\r\n(e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be\r\n\"about:blank\".",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;\r\nsee[RFC7231], Section 3.4).",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "nullable": true
          }
        },
        "additionalProperties": {},
        "description": "A machine-readable format for specifying errors in HTTP API responses based on <see href=\"https://tools.ietf.org/html/rfc7807\" />."
      },
      "SmartSurvey.Enums.SurveyPresentationMode": {
        "enum": [
          0,
          1,
          2
        ],
        "type": "integer",
        "format": "int32"
      },
      "SmartSurvey.Public.API.Models.Surveys.SurveyProperties": {
        "type": "object",
        "properties": {
          "scoring": {
            "type": "boolean",
            "description": "Whether scoring is enabled for the survey.",
            "nullable": true
          },
          "presentation_mode": {
            "$ref": "#/components/schemas/SmartSurvey.Enums.SurveyPresentationMode"
          }
        },
        "additionalProperties": false,
        "description": "Survey-level settings. Each field is optional — on a request, omit a field to leave that setting unchanged."
      },
      "SmartSurvey.Public.API.Models.Surveys.SurveySingleResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique survey id",
            "format": "int32"
          },
          "type": {
            "type": "string",
            "description": "The type of survey",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "The survey title",
            "nullable": true
          },
          "nickname": {
            "type": "string",
            "description": "An optional nickname which is used to refer to the survey internally",
            "nullable": true
          },
          "date_created": {
            "type": "string",
            "description": "The date the survey was created in UTC",
            "format": "date-time"
          },
          "date_modified": {
            "type": "string",
            "description": "The date the survey was last modified in UTC",
            "format": "date-time"
          },
          "folder_id": {
            "type": "integer",
            "description": "The id of the folder this survey is filed in, or 0 when it is not in a folder. Always 0 for a\r\nsurvey shared with you by another account, because a survey's folder belongs to its owner.",
            "format": "int32"
          },
          "responses": {
            "type": "integer",
            "description": "The number of responses for this survey",
            "format": "int32"
          },
          "status": {
            "type": "string",
            "description": "The status of the survey e.g. open or closed",
            "nullable": true
          },
          "survey_url": {
            "type": "string",
            "description": "The default survey link for this survey",
            "nullable": true
          },
          "href": {
            "type": "string",
            "description": "The API hyperlink to this survey",
            "nullable": true
          },
          "href_responses": {
            "type": "string",
            "description": "The API hyperlink to the responses",
            "nullable": true
          },
          "href_links": {
            "type": "string",
            "description": "The API hyperlink to get all survey tracking links",
            "nullable": true
          },
          "page_count": {
            "type": "integer",
            "description": "The number of pages in this survey",
            "format": "int32"
          },
          "question_count": {
            "type": "integer",
            "description": "The number of questions in this survey",
            "format": "int32"
          },
          "theme_id": {
            "type": "integer",
            "description": "The id of the theme applied to this survey",
            "format": "int32"
          },
          "properties": {
            "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.Surveys.SurveyProperties"
          }
        },
        "additionalProperties": false,
        "description": "The response object for a single entry which is more detailed than the listing but less than \"detailed\""
      }
    },
    "securitySchemes": {
      "Basic": {
        "type": "http",
        "description": "Basic Authorization",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "Basic": []
    }
  ]
}
```