{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/folder.json","auth":"required","method":"get","params":[{"name":"page","type":"int","default":"","desc":"Page to use when paginating through forms. Starts at 1.","required":false,"in":"query","ref":"","_id":"5810e7c78a4aed0f00d6759e"},{"name":"per_page","type":"int","default":"","desc":"Number of forms to return per page. Minimum page limit is 10.","required":false,"in":"query","ref":"","_id":"5810e7c78a4aed0f00d6759d"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"folders\": [\n    {\n      \"id\": \"1001\",\n      \"name\": \"Folder 1\",\n      \"parent\": \"0\",\n      \"permissions\": \"full\",\n      \"subfolders\": [\n        {\n          \"id\": \"1002\",\n          \"name\": \"Subfolder 1\",\n          \"parent\": \"1001\",\n          \"permissions\": \"full\"\n        }\n      ]\n    }\n  ],\n  \"total\": 1\n}","name":""}]},"settings":"5e2b1ec0f26a2c00510363e5","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"/folder","type":"endpoint","slug":"folder-get","excerpt":"Get all folders on your account and their subfolders.","body":"Get all folders in your account\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/v2/folder.json HTTP/1.1\\nHost: www.formstack.com\\nAuthorization: Bearer [[app:oauth_token]]\\nAccept: application/json\\nContent-Type: application/json\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -i -H \\\"Accept: application/json\\\" -H \\\"Content-Type: application/json\\\" -H \\\"Authorization: Bearer [[app:oauth_token]]\\\" https://www.formstack.com/api/v2/folder.json\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nPaginate through the folders in your account\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/v2/folder.json?page=2&per_page=50 HTTP/1.1\\nHost: www.formstack.com\\nAuthorization: Bearer [[app:oauth_token]]\\nAccept: application/json\\nContent-Type: application/json\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -i -H \\\"Accept: application/json\\\" -H \\\"Content-Type: application/json\\\" -H \\\"Authorization: Bearer [[app:oauth_token]]\\\" https://www.formstack.com/api/v2/folder.json?page=2&per_page=50\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","updates":[],"order":22,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5810cf1708d8050f00948dbd","category":{"sync":{"isSync":false,"url":""},"pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"title":"REST API","slug":"rest-api","order":1,"from_sync":false,"reference":false,"_id":"5434918d0ef9c008001651ff","version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","createdAt":"2014-10-08T01:21:17.804Z"},"githubsync":"","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"_id":"54346a2a0ef9c00800164f28","releaseDate":"2014-10-07T22:33:14.982Z","createdAt":"2014-10-07T22:33:14.982Z","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8},"createdAt":"2016-10-26T15:43:19.503Z","parentDoc":null,"__v":3,"project":"543469460ef9c00800164f0e","user":"543469060ef9c00800164f01"}

get/folder

Get all folders on your account and their subfolders.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer
Page to use when paginating through forms. Starts at 1.
per_page:
integer
Number of forms to return per page. Minimum page limit is 10.

Result Format


Documentation

Get all folders in your account [block:code] { "codes": [ { "code": "GET /api/v2/folder.json HTTP/1.1\nHost: www.formstack.com\nAuthorization: Bearer [[app:oauth_token]]\nAccept: application/json\nContent-Type: application/json", "language": "http" }, { "code": "curl -i -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Authorization: Bearer [[app:oauth_token]]\" https://www.formstack.com/api/v2/folder.json", "language": "shell" } ] } [/block] Paginate through the folders in your account [block:code] { "codes": [ { "code": "GET /api/v2/folder.json?page=2&per_page=50 HTTP/1.1\nHost: www.formstack.com\nAuthorization: Bearer [[app:oauth_token]]\nAccept: application/json\nContent-Type: application/json", "language": "http" }, { "code": "curl -i -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"Authorization: Bearer [[app:oauth_token]]\" https://www.formstack.com/api/v2/folder.json?page=2&per_page=50", "language": "shell" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}