{"_id":"54680584016b480800bc7ca0","githubsync":"","__v":0,"category":{"_id":"5467f78698b68408002689f8","__v":13,"project":"5467f78598b68408002689f4","pages":["5467f78698b68408002689fa","54680584016b480800bc7ca0","546806af016b480800bc7ca3","5468084998b6840800268a28","546808fe016b480800bc7ca6","546809b098b6840800268a32","54680ab898b6840800268a42","54680b5d016b480800bc7cc2","54680b9a016b480800bc7cc5","5468293298b6840800268a79","54682958016b480800bc7cf9","54682fbc016b480800bc7cfd","54f664fd542ade0d00f1c69b"],"version":"5467f78598b68408002689f7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-16T01:01:58.022Z","from_sync":false,"order":0,"slug":"api-documentation","title":"API Documentation"},"editedParams2":true,"user":"5467f76e016b480800bc7c7d","project":"5467f78598b68408002689f4","version":{"_id":"5467f78598b68408002689f7","project":"5467f78598b68408002689f4","__v":1,"createdAt":"2014-11-16T01:01:57.550Z","releaseDate":"2014-11-16T01:01:57.550Z","categories":["5467f78698b68408002689f8"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"editedParams":true,"is_link":false,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-11-16T02:01:40.626Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"try":false,"basic_auth":false,"method":"get","results":{"codes":[{"name":"","code":"{\n  \"data\":[\n    {\n      \"name\":\"about.md\",\n      \"path\":\"/about.md\",\n      \"isDir\":false,\n      \"size\":1231,\n      \"modTime\":1415837672\n    },\n    {\n      \"name\":\"bio.md\",\n      \"path\":\"/bio.md\",\n      \"isDir\":false,\n      \"size\":1889,\n      \"modTime\":1415931913\n    },\n    {\n      \"name\":\"contact.md\",\n      \"path\":\"/contact.md\",\n      \"isDir\":false,\n      \"size\":517,\n      \"modTime\":1415837672\n    },\n    {\n      \"name\":\"gallery\",\n      \"path\":\"/gallery\",\n      \"isDir\":true,\n      \"size\":442,\n      \"modTime\":1416298837\n    },\n    {\n      \"name\":\"process\",\n      \"path\":\"/process\",\n      \"isDir\":true,\n      \"size\":204,\n      \"modTime\":1416298831\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{\n  \"code\": 404,\n  \"status\": \"Not Found\",\n  \"message\": \"Directory does not exist\"\n}","language":"json","status":404}]},"auth":"never","params":[{"_id":"54680584016b480800bc7ca1","ref":"","in":"path","required":false,"desc":"Path to an existing directory that you want to get the contents of","default":"","type":"string","name":"path"}],"url":"/api/dir/:path"},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('/api/dir/foo');\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"read-directory","type":"endpoint","title":"Read Directory"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

path:
string
Path to an existing directory that you want to get the contents of

Result Format


Documentation

[block:code] { "codes": [ { "code": "$.get('/api/dir/foo');", "language": "javascript" } ] } [/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 }}