{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/api/page/:path","auth":"never","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"page\":{\n    \"path\":\"/lorem-ipsum.md\",\n    \"metadata\":{\n      \"description\":\"bla bla bla\",\n      \"title\":\"Lorem Ipsum\"\n    },\n    \"content\":\"# Hello World\"\n  }\n}","name":""},{"status":404,"language":"json","code":"{\n  \"code\": 404,\n  \"status\": \"Not Found\",\n  \"message\": \"Page does not exist\"\n}","name":""}]},"try":false,"basic_auth":false,"method":"get","params":[{"name":"path","type":"string","default":"","desc":"Which page to read","required":false,"in":"path","ref":"","_id":"546808fe016b480800bc7ca7"}]},"next":{"description":"","pages":[]},"title":"Read Page","type":"endpoint","slug":"read-page","excerpt":"","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('/api/page/lorem-ipsum.md');\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"546808fe016b480800bc7ca6","project":"5467f78598b68408002689f4","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5467f78698b68408002689f8"],"_id":"5467f78598b68408002689f7","project":"5467f78598b68408002689f4","releaseDate":"2014-11-16T01:01:57.550Z","__v":1,"createdAt":"2014-11-16T01:01:57.550Z"},"githubsync":"","is_link":false,"createdAt":"2014-11-16T02:16:30.412Z","editedParams":true,"editedParams2":true,"user":"5467f76e016b480800bc7c7d","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["5467f78698b68408002689fa","54680584016b480800bc7ca0","546806af016b480800bc7ca3","5468084998b6840800268a28","546808fe016b480800bc7ca6","546809b098b6840800268a32","54680ab898b6840800268a42","54680b5d016b480800bc7cc2","54680b9a016b480800bc7cc5","5468293298b6840800268a79","54682958016b480800bc7cf9","54682fbc016b480800bc7cfd","54f664fd542ade0d00f1c69b"],"title":"API Documentation","slug":"api-documentation","order":0,"from_sync":false,"reference":false,"_id":"5467f78698b68408002689f8","__v":13,"project":"5467f78598b68408002689f4","createdAt":"2014-11-16T01:01:58.022Z","version":"5467f78598b68408002689f7"}}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

path:
string
Which page to read

Result Format


Documentation

[block:code] { "codes": [ { "code": "$.get('/api/page/lorem-ipsum.md');", "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 }}