Get a survey folder

GET 
/v3/survey_folders/:id

Get a survey folder

Request

Path Parameters

id numberrequired

Query Parameters

enable_subfolders boolean

Pass true to get the survey folder with its subfolders, surveys, and echoes

Responses

200

Successful

*/*

Schema

Schema

data

object

id number

name string

Possible values: <= 100 characters

description string

Possible values: <= 200 characters

auto_created boolean

visibility string

Possible values: [ALL, PRIVATE]

teams number[]

surveys

object[]

Array [

id number

name string

surveType string

]

parent_survey_folder_id number

users number[]

subfolders

object[]

Array [

id number

name string

]

echoes

object[]

Array [

id number

name string

]

Example (from schema)

{
  "data": {
    "id": 1,
    "name": "General",
    "description": "The general Workspace",
    "auto_created": true,
    "visibility": "ALL",
    "teams": [
      0
    ],
    "surveys": [
      {
        "id": 1,
        "name": "My First Survey",
        "surveType": "string"
      }
    ],
    "parent_survey_folder_id": 0,
    "users": [
      0
    ],
    "subfolders": [
      {
        "id": 1,
        "name": "Sub Folder"
      }
    ],
    "echoes": [
      {
        "id": 1,
        "name": "My Echo"
      }
    ]
  }
}

Loading...