{"_id":"5608d0e931beb60d001b6545","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"project":"56035b550c78b00d0039af2f","user":"55cc353caeb9ba0d00395305","version":"5608d0e831beb60d001b6542","order":0,"title":"Introduction","link_external":false,"githubsync":"","hidden":false,"slug":"getting-started","type":"basic","body":"The Padlet API is a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API. All calls return data in the [JSON](https://en.wikipedia.org/wiki/JSON)  format.\n\nAll API calls need to be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). API calls made over plain HTTP will fail.","category":"5608d0e831beb60d001b6543","createdAt":"2015-09-24T02:09:28.490Z","excerpt":"","link_url":"","sync_unique":"","updates":["5a9d8177ce9782001c81de21"],"__v":9,"isReference":false,"next":{"pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Introduction


The Padlet API is a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API. All calls return data in the [JSON](https://en.wikipedia.org/wiki/JSON) format. All API calls need to be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). API calls made over plain HTTP will fail.
The Padlet API is a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API. All calls return data in the [JSON](https://en.wikipedia.org/wiki/JSON) format. All API calls need to be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). API calls made over plain HTTP will fail.
{"_id":"560b533d5148ba0d009bd0be","link_url":"","slug":"creating-an-application","sync_unique":"","title":"Creating An Application","type":"basic","body":"Before using the Padlet API, you need to create a Padlet account and an application.\nFollow these simple steps to create an application.  \n\n1. [Sign up](https://padlet.com/auth/signup) for a padlet account if you don't already have one.\n2. Access [Settings > Developer](https://padlet.com/my/settings/developer)  to create an application.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/eX24VqjBSw25jMMorDhs_Selection_037.png\",\n        \"Selection_037.png\",\n        \"751\",\n        \"678\",\n        \"#ea3f77\",\n        \"\"\n      ],\n      \"caption\": \"Creating an application\"\n    }\n  ]\n}\n[/block]","category":"5608d0e831beb60d001b6543","user":"55cc353caeb9ba0d00395305","version":"5608d0e831beb60d001b6542","link_external":false,"hidden":false,"order":1,"createdAt":"2015-09-30T03:13:01.015Z","excerpt":"","githubsync":"","project":"56035b550c78b00d0039af2f","updates":["598bd34ee27e0a000f9957e0","5c26133edbd6b7001aece09e","5db0d694077e64001132a913"],"__v":13,"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"isReference":false,"next":{"pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Creating An Application


Before using the Padlet API, you need to create a Padlet account and an application. Follow these simple steps to create an application. 1. [Sign up](https://padlet.com/auth/signup) for a padlet account if you don't already have one. 2. Access [Settings > Developer](https://padlet.com/my/settings/developer) to create an application. [block:image] { "images": [ { "image": [ "https://files.readme.io/eX24VqjBSw25jMMorDhs_Selection_037.png", "Selection_037.png", "751", "678", "#ea3f77", "" ], "caption": "Creating an application" } ] } [/block]
Before using the Padlet API, you need to create a Padlet account and an application. Follow these simple steps to create an application. 1. [Sign up](https://padlet.com/auth/signup) for a padlet account if you don't already have one. 2. Access [Settings > Developer](https://padlet.com/my/settings/developer) to create an application. [block:image] { "images": [ { "image": [ "https://files.readme.io/eX24VqjBSw25jMMorDhs_Selection_037.png", "Selection_037.png", "751", "678", "#ea3f77", "" ], "caption": "Creating an application" } ] } [/block]
{"_id":"560b53b32d00ca0d00a1fdab","link_url":"","slug":"terminology","sync_unique":"","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"category":"5608d0e831beb60d001b6543","excerpt":"","order":2,"user":"55cc353caeb9ba0d00395305","githubsync":"","hidden":false,"link_external":false,"project":"56035b550c78b00d0039af2f","__v":1,"body":"The Padlet API can be used to create, read, update and delete content on Padlet.\n\nSome simple terminology: \n* __Padlets__ - padlets are the surfaces which you can post content on.\n* __Posts__ - posts are pinned onto a padlet. Posts can be text with an accompanying URL or file.","updates":["5a240099e24c7e0026358fc9"],"version":"5608d0e831beb60d001b6542","createdAt":"2015-09-30T03:14:59.506Z","title":"Terminology","type":"basic","isReference":false,"next":{"pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Terminology


The Padlet API can be used to create, read, update and delete content on Padlet. Some simple terminology: * __Padlets__ - padlets are the surfaces which you can post content on. * __Posts__ - posts are pinned onto a padlet. Posts can be text with an accompanying URL or file.
The Padlet API can be used to create, read, update and delete content on Padlet. Some simple terminology: * __Padlets__ - padlets are the surfaces which you can post content on. * __Posts__ - posts are pinned onto a padlet. Posts can be text with an accompanying URL or file.
{"_id":"5608d2088aedf50d0004cf7a","version":"5608d0e831beb60d001b6542","__v":7,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"name\",\n    \"h-1\": \"type\",\n    \"0-0\": \"name\",\n    \"0-1\": \"string\",\n    \"1-0\": \"username\",\n    \"1-1\": \"string\",\n    \"2-0\": \"avatar\",\n    \"2-1\": \"string\",\n    \"3-0\": \"bio\",\n    \"3-1\": \"string\",\n    \"2-2\": \"user's profile picture url\",\n    \"3-2\": \"user's short description\",\n    \"h-2\": \"description\",\n    \"0-2\": \"user's name\",\n    \"1-2\": \"user's username\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","slug":"user-profile-object","type":"basic","api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"","auth":"required","params":[]},"title":"User Profile Object","updates":["5caaabbc36bfa200394e489e"],"link_url":"","sync_unique":"","category":"5608d0e831beb60d001b6544","excerpt":"","githubsync":"","link_external":false,"user":"55cc353caeb9ba0d00395305","createdAt":"2015-09-28T05:37:12.392Z","hidden":false,"order":0,"project":"56035b550c78b00d0039af2f","isReference":false,"next":{"pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

User Profile Object


[block:parameters] { "data": { "h-0": "name", "h-1": "type", "0-0": "name", "0-1": "string", "1-0": "username", "1-1": "string", "2-0": "avatar", "2-1": "string", "3-0": "bio", "3-1": "string", "2-2": "user's profile picture url", "3-2": "user's short description", "h-2": "description", "0-2": "user's name", "1-2": "user's username" }, "cols": 3, "rows": 4 } [/block]
[block:parameters] { "data": { "h-0": "name", "h-1": "type", "0-0": "name", "0-1": "string", "1-0": "username", "1-1": "string", "2-0": "avatar", "2-1": "string", "3-0": "bio", "3-1": "string", "2-2": "user's profile picture url", "3-2": "user's short description", "h-2": "description", "0-2": "user's name", "1-2": "user's username" }, "cols": 3, "rows": 4 } [/block]
{"_id":"5608d0e931beb60d001b6546","link_external":false,"order":1,"title":"Get User Profile","editedParams":true,"version":"5608d0e831beb60d001b6542","api":{"auth":"required","examples":{"codes":[{"name":"","code":"curl -XGET -H 'App-Id: 4705250fa45571490b6e3b55fcd8b08d3377d654c985d7af794b08005c35b892' -H \"Content-type: application/json\" 'https://padlet.com/api/0.9/users/public_profile?username=deepan'\n\n\n","language":"curl"}]},"method":"get","params":[{"_id":"563161314b36120d00fdec3a","default":"","desc":"Get user with with given user_id","name":"user_id","required":false,"type":"string","in":"query"},{"_id":"5633de727e9e880d00af1a36","default":"","desc":"Get user with given username","name":"username","required":false,"type":"string","in":"query"}],"results":{"codes":[{"name":"","code":"{\n    \"data\": [\n        {\n            \"id\": 71384074,\n            \"name\": \"Deepan\",\n            \"username\": \"deepan\",\n            \"bio\": \"Engineer@Padlet\",\n            \"avatar_url\": \"http://d20uo2axdbh83k.cloudfront.net/151113/6db7bacbc76fa94174f7e5f401f8ac93.jpg\"\n        }\n    ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"5608d0326d8c440d000c79dc","url":"/users/public_profile.json"},"excerpt":"Basic public information about a user","githubsync":"","link_url":"","project":"56035b550c78b00d0039af2f","sync_unique":"","type":"get","user":"55cc353caeb9ba0d00395305","createdAt":"2015-09-25T04:16:43.801Z","editedParams2":true,"category":"5608d0e831beb60d001b6544","hidden":false,"slug":"get-user-profile","updates":["5caaac149e69b8005d762924"],"__v":32,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Headers\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Content-Type\",\n    \"h-0\": \"name\",\n    \"h-1\": \"description\",\n    \"h-2\": \"type\",\n    \"0-1\": \"indicates the media type\",\n    \"1-0\": \"App-Id\",\n    \"1-1\": \"App-Id from the developer panel of your dashboard\",\n    \"h-3\": \"required?\",\n    \"0-2\": \"string\",\n    \"0-3\": \"true\",\n    \"1-2\": \"string\",\n    \"1-3\": \"true\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"'application/json'\",\n    \"1-4\": \"None\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Filter Parameters\"\n}\n[/block]\nEndpoint requires one of the following filter parameters.  \nEndpoint only accepts one filter parameter, and will match the first valid parameter found.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"name\",\n    \"h-1\": \"description\",\n    \"h-2\": \"type\",\n    \"h-3\": \"r\",\n    \"0-0\": \"username\",\n    \"0-1\": \"User's username\",\n    \"0-2\": \"string\",\n    \"1-0\": \"user_id\",\n    \"1-1\": \"User's unique id\",\n    \"1-2\": \"id\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","isReference":false,"next":{"pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet User Profile

Basic public information about a user

Query Params

user_id:
string
Get user with with given user_id
username:
string
Get user with given username
[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Filter Parameters" } [/block] Endpoint requires one of the following filter parameters. Endpoint only accepts one filter parameter, and will match the first valid parameter found. [block:parameters] { "data": { "h-0": "name", "h-1": "description", "h-2": "type", "h-3": "r", "0-0": "username", "0-1": "User's username", "0-2": "string", "1-0": "user_id", "1-1": "User's unique id", "1-2": "id" }, "cols": 3, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Filter Parameters" } [/block] Endpoint requires one of the following filter parameters. Endpoint only accepts one filter parameter, and will match the first valid parameter found. [block:parameters] { "data": { "h-0": "name", "h-1": "description", "h-2": "type", "h-3": "r", "0-0": "username", "0-1": "User's username", "0-2": "string", "1-0": "user_id", "1-1": "User's unique id", "1-2": "id" }, "cols": 3, "rows": 2 } [/block]
{"_id":"562e99913b2af20d006ad030","order":0,"sync_unique":"","title":"Padlet Object","version":"5608d0e831beb60d001b6542","category":"562e99825fe1240d00a562d9","excerpt":"","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"name\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"id\",\n    \"0-1\": \"integer\",\n    \"0-2\": \"wall's unique id\",\n    \"1-0\": \"title\",\n    \"1-1\": \"string\",\n    \"1-2\": \"wall's title\",\n    \"3-0\": \"name\",\n    \"3-1\": \"string\",\n    \"3-2\": \"the name of the wall in alphanumeric characters and underscores.\",\n    \"4-0\": \"namespace\",\n    \"4-1\": \"string\",\n    \"5-0\": \"privacy_type\",\n    \"6-0\": \"thmbs_graphic\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"7-0\": \"viz\",\n    \"7-1\": \"string\",\n    \"8-0\": \"theme_id\",\n    \"8-1\": \"id\",\n    \"9-0\": \"domain_name\",\n    \"9-1\": \"string\",\n    \"10-0\": \"created_at\",\n    \"10-1\": \"string\",\n    \"11-0\": \"updated_at\",\n    \"11-1\": \"string\",\n    \"2-0\": \"subtitle\",\n    \"2-1\": \"string\",\n    \"2-2\": \"wall's subtitle\",\n    \"4-2\": \"used for building url for the wall, usually coincides with username of wall builder\",\n    \"5-2\": \"wall's privacy setting. `public`, `private`, `hidden` or `password`\",\n    \"6-2\": \"url to the wall's thumbnail, if one exists\",\n    \"7-2\": \"layout of the wall.`stream`, `grid` or `free`\",\n    \"8-2\": \"id of theme used to style the wall\",\n    \"9-2\": \"domain name that has been mapped to the wall\",\n    \"10-2\": \"date and time wall was created at, in iso 8601 format\",\n    \"11-2\": \"date and time wall was last updated, in iso 8601 format  property :friendly\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","createdAt":"2015-10-26T21:22:25.051Z","githubsync":"","project":"56035b550c78b00d0039af2f","__v":10,"slug":"wall-object","updates":["59a844d85f69db002f7fd070"],"link_url":"","type":"basic","user":"55cc353caeb9ba0d00395305","hidden":false,"link_external":false,"isReference":false,"next":{"pages":[]},"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Padlet Object


[block:parameters] { "data": { "h-0": "name", "h-1": "type", "h-2": "description", "0-0": "id", "0-1": "integer", "0-2": "wall's unique id", "1-0": "title", "1-1": "string", "1-2": "wall's title", "3-0": "name", "3-1": "string", "3-2": "the name of the wall in alphanumeric characters and underscores.", "4-0": "namespace", "4-1": "string", "5-0": "privacy_type", "6-0": "thmbs_graphic", "5-1": "string", "6-1": "string", "7-0": "viz", "7-1": "string", "8-0": "theme_id", "8-1": "id", "9-0": "domain_name", "9-1": "string", "10-0": "created_at", "10-1": "string", "11-0": "updated_at", "11-1": "string", "2-0": "subtitle", "2-1": "string", "2-2": "wall's subtitle", "4-2": "used for building url for the wall, usually coincides with username of wall builder", "5-2": "wall's privacy setting. `public`, `private`, `hidden` or `password`", "6-2": "url to the wall's thumbnail, if one exists", "7-2": "layout of the wall.`stream`, `grid` or `free`", "8-2": "id of theme used to style the wall", "9-2": "domain name that has been mapped to the wall", "10-2": "date and time wall was created at, in iso 8601 format", "11-2": "date and time wall was last updated, in iso 8601 format property :friendly" }, "cols": 3, "rows": 12 } [/block]
[block:parameters] { "data": { "h-0": "name", "h-1": "type", "h-2": "description", "0-0": "id", "0-1": "integer", "0-2": "wall's unique id", "1-0": "title", "1-1": "string", "1-2": "wall's title", "3-0": "name", "3-1": "string", "3-2": "the name of the wall in alphanumeric characters and underscores.", "4-0": "namespace", "4-1": "string", "5-0": "privacy_type", "6-0": "thmbs_graphic", "5-1": "string", "6-1": "string", "7-0": "viz", "7-1": "string", "8-0": "theme_id", "8-1": "id", "9-0": "domain_name", "9-1": "string", "10-0": "created_at", "10-1": "string", "11-0": "updated_at", "11-1": "string", "2-0": "subtitle", "2-1": "string", "2-2": "wall's subtitle", "4-2": "used for building url for the wall, usually coincides with username of wall builder", "5-2": "wall's privacy setting. `public`, `private`, `hidden` or `password`", "6-2": "url to the wall's thumbnail, if one exists", "7-2": "layout of the wall.`stream`, `grid` or `free`", "8-2": "id of theme used to style the wall", "9-2": "domain name that has been mapped to the wall", "10-2": "date and time wall was created at, in iso 8601 format", "11-2": "date and time wall was last updated, in iso 8601 format property :friendly" }, "cols": 3, "rows": 12 } [/block]
{"_id":"562eb4110536db0d0042ee51","type":"get","api":{"examples":{"codes":[{"language":"curl","code":"curl -XGET -H 'App-Id: 4705250fa45571490b6e3b55fcd8b08d3377d654c985d7af794b08005c35b892' -H \"Content-type: application/json\" 'https://padlet.com/api/0.9/public_padlets?username=deepan'","name":""}]},"method":"get","params":[{"_id":"562ebc72fcb8340d0005fda2","default":"test1","desc":"Get padlets of user with given username","name":"username","required":false,"type":"string","in":"query"},{"in":"query","_id":"5640a6ed6886400d00b8dc3e","default":"","desc":"Get padlets of user with given user_id","name":"user_id","required":false,"type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"id\": 20891487,\n            \"name\": \"superheroes\",\n            \"title\": \"Superheroes\"\n        },\n    ],\n    \"meta\": {\n        \"current_page\": 1,\n        \"total_pages\": 1,\n        \"total_entries\": 1,\n        \"per_page\": 20\n    }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"5608d0326d8c440d000c79dc","url":"/public_padlets","auth":"required"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Headers\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Content-Type\",\n    \"h-0\": \"name\",\n    \"h-1\": \"description\",\n    \"h-2\": \"type\",\n    \"0-1\": \"indicates the media type\",\n    \"1-0\": \"App-Id\",\n    \"1-1\": \"App-Id from the developer panel of your dashboard\",\n    \"h-3\": \"required?\",\n    \"0-2\": \"string\",\n    \"0-3\": \"true\",\n    \"1-2\": \"string\",\n    \"1-3\": \"true\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"'application/json'\",\n    \"1-4\": \"None\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Filter Parmeters\"\n}\n[/block]\nEndpoint requires one of the following filter parameters.  \nEndpoint only accepts one filter parameter, and will match the first valid parameter found.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"parameters\",\n    \"h-1\": \"description\",\n    \"0-0\": \"username\",\n    \"0-1\": \"user's username\",\n    \"h-2\": \"type\",\n    \"0-2\": \"string\",\n    \"h-3\": \"required?\",\n    \"0-3\": \"\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"None\",\n    \"1-0\": \"user_id\",\n    \"1-1\": \"user's unique id\",\n    \"1-2\": \"integer\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","category":"562e99825fe1240d00a562d9","editedParams":true,"excerpt":"","hidden":false,"editedParams2":true,"githubsync":"","link_external":false,"sync_unique":"","slug":"get-a-list-of-walls-for-user","title":"Get Padlets Collection","updates":[],"__v":3,"createdAt":"2015-10-26T23:15:29.442Z","link_url":"","order":1,"project":"56035b550c78b00d0039af2f","user":"55cc353caeb9ba0d00395305","version":"5608d0e831beb60d001b6542","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet Padlets Collection


Query Params

username:
stringtest1
Get padlets of user with given username
user_id:
integer
Get padlets of user with given user_id
[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Filter Parmeters" } [/block] Endpoint requires one of the following filter parameters. Endpoint only accepts one filter parameter, and will match the first valid parameter found. [block:parameters] { "data": { "h-0": "parameters", "h-1": "description", "0-0": "username", "0-1": "user's username", "h-2": "type", "0-2": "string", "h-3": "required?", "0-3": "", "h-4": "default value", "0-4": "None", "1-0": "user_id", "1-1": "user's unique id", "1-2": "integer" }, "cols": 3, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Filter Parmeters" } [/block] Endpoint requires one of the following filter parameters. Endpoint only accepts one filter parameter, and will match the first valid parameter found. [block:parameters] { "data": { "h-0": "parameters", "h-1": "description", "0-0": "username", "0-1": "user's username", "h-2": "type", "0-2": "string", "h-3": "required?", "0-3": "", "h-4": "default value", "0-4": "None", "1-0": "user_id", "1-1": "user's unique id", "1-2": "integer" }, "cols": 3, "rows": 2 } [/block]
{"_id":"56317ac0dcc27a170082357d","category":"562e99825fe1240d00a562d9","createdAt":"2015-10-29T01:47:44.825Z","editedParams":true,"order":2,"user":"55cc353caeb9ba0d00395305","editedParams2":true,"hidden":false,"link_external":false,"link_url":"","project":"56035b550c78b00d0039af2f","type":"get","updates":[],"version":"5608d0e831beb60d001b6542","__v":2,"slug":"padlets-by-id","sync_unique":"","title":"Get Padlet Object","api":{"url":"/public_padlets/:id","auth":"required","examples":{"codes":[{"code":"curl -XGET -H 'App-Id: 4705250fa45571490b6e3b55fcd8b08d3377d654c985d7af794b08005c35b892' -H \"Content-type: application/json\" 'https://padlet.com/api/0.9/public_padlets/20891487'","name":"","language":"curl"}]},"method":"get","params":[{"desc":"unique id of the padlet","default":"","type":"int","name":"id","in":"path","_id":"562ebc72fcb8340d0005fda2","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": {\n        \"id\": 20891487,\n        \"title\": \"Superheroes \",\n        \"subtitle\": \"Sample API Padlet\",\n        \"namespace\": \"deepan\",\n        \"name\": \"superheroes\",\n        \"privacy_type\": \"public\",\n        \"thmbs_graphic\": \"\",\n        \"updated_at\": \"2015-12-03T06:28:17.655Z\",\n        \"created_at\": \"2015-12-03T05:54:24.160Z\",\n        \"background\": {\n            \"url\": \"https://padlet-assets.storage.googleapis.com/bg/paper.jpg\"\n        },\n        \"domain_name\": \"\",\n        \"viz\": \"stream\",\n        \"theme_id\": 1\n    }\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"5608d0326d8c440d000c79dc"},"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Headers\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Content-Type\",\n    \"h-0\": \"name\",\n    \"h-1\": \"description\",\n    \"h-2\": \"type\",\n    \"0-1\": \"indicates the media type\",\n    \"1-0\": \"App-Id\",\n    \"1-1\": \"App-Id from the developer panel of your dashboard\",\n    \"h-3\": \"required?\",\n    \"0-2\": \"string\",\n    \"0-3\": \"true\",\n    \"1-2\": \"string\",\n    \"1-3\": \"true\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"'application/json'\",\n    \"1-4\": \"None\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]","excerpt":"","githubsync":"","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet Padlet Object


Path Params

id:
required
integer
unique id of the padlet
[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block]
{"_id":"5640a95b2b14f70d0039b898","hidden":false,"slug":"post-object","type":"basic","version":"5608d0e831beb60d001b6542","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"name\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"id\",\n    \"0-1\": \"integer\",\n    \"0-2\": \"unique id of post\",\n    \"1-0\": \"subject\",\n    \"1-1\": \"string\",\n    \"1-2\": \"subject for post, can be empty string\",\n    \"2-0\": \"body\",\n    \"2-1\": \"string\",\n    \"2-2\": \"body text for post, can be empty string\",\n    \"3-0\": \"attachment\",\n    \"3-1\": \"string\",\n    \"3-2\": \"url to the attachment for a post, can be empty string\",\n    \"4-0\": \"created_at\",\n    \"4-1\": \"string\",\n    \"4-2\": \"datetime post was created at, in ISO 8601 format\",\n    \"5-0\": \"updated_at\",\n    \"5-1\": \"string\",\n    \"5-2\": \"datetime post was updated at, in ISO 8601 format\",\n    \"6-0\": \"attachment_type\",\n    \"6-1\": \"string\",\n    \"6-2\": \"description of the type of the attachment\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\nList of common (but not exhaustive) attachment_types\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"photo\",\n    \"h-0\": \"attachment_type\",\n    \"h-1\": \"description\",\n    \"1-0\": \"link\",\n    \"2-0\": \"document\",\n    \"3-0\": \"video\",\n    \"4-0\": \"audio\",\n    \"5-0\": \"cad\",\n    \"6-0\": \"flash\",\n    \"7-0\": \"code\",\n    \"2-1\": \"pdfs, google docs etc\",\n    \"1-1\": \"link to an external resource\",\n    \"0-1\": \"jpeg, gif, png, bmp etc\",\n    \"3-1\": \"flv, webm, mp4, wmv etc\",\n    \"4-1\": \"mp3, wav, m4a etc\",\n    \"5-1\": \"Computer Aided Design files\",\n    \"6-1\": \"swf files\",\n    \"7-1\": \"py, js, java etc\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","createdAt":"2015-11-09T14:10:35.262Z","link_url":"","order":0,"link_external":false,"sync_unique":"","title":"Post Object","updates":[],"user":"55cc353caeb9ba0d00395305","__v":2,"category":"5640a94ad4b2e00d00bb3cbf","githubsync":"","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]}},"excerpt":"","project":"56035b550c78b00d0039af2f","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Post Object


[block:parameters] { "data": { "h-0": "name", "h-1": "type", "h-2": "description", "0-0": "id", "0-1": "integer", "0-2": "unique id of post", "1-0": "subject", "1-1": "string", "1-2": "subject for post, can be empty string", "2-0": "body", "2-1": "string", "2-2": "body text for post, can be empty string", "3-0": "attachment", "3-1": "string", "3-2": "url to the attachment for a post, can be empty string", "4-0": "created_at", "4-1": "string", "4-2": "datetime post was created at, in ISO 8601 format", "5-0": "updated_at", "5-1": "string", "5-2": "datetime post was updated at, in ISO 8601 format", "6-0": "attachment_type", "6-1": "string", "6-2": "description of the type of the attachment" }, "cols": 3, "rows": 7 } [/block] List of common (but not exhaustive) attachment_types [block:parameters] { "data": { "0-0": "photo", "h-0": "attachment_type", "h-1": "description", "1-0": "link", "2-0": "document", "3-0": "video", "4-0": "audio", "5-0": "cad", "6-0": "flash", "7-0": "code", "2-1": "pdfs, google docs etc", "1-1": "link to an external resource", "0-1": "jpeg, gif, png, bmp etc", "3-1": "flv, webm, mp4, wmv etc", "4-1": "mp3, wav, m4a etc", "5-1": "Computer Aided Design files", "6-1": "swf files", "7-1": "py, js, java etc" }, "cols": 2, "rows": 8 } [/block]
[block:parameters] { "data": { "h-0": "name", "h-1": "type", "h-2": "description", "0-0": "id", "0-1": "integer", "0-2": "unique id of post", "1-0": "subject", "1-1": "string", "1-2": "subject for post, can be empty string", "2-0": "body", "2-1": "string", "2-2": "body text for post, can be empty string", "3-0": "attachment", "3-1": "string", "3-2": "url to the attachment for a post, can be empty string", "4-0": "created_at", "4-1": "string", "4-2": "datetime post was created at, in ISO 8601 format", "5-0": "updated_at", "5-1": "string", "5-2": "datetime post was updated at, in ISO 8601 format", "6-0": "attachment_type", "6-1": "string", "6-2": "description of the type of the attachment" }, "cols": 3, "rows": 7 } [/block] List of common (but not exhaustive) attachment_types [block:parameters] { "data": { "0-0": "photo", "h-0": "attachment_type", "h-1": "description", "1-0": "link", "2-0": "document", "3-0": "video", "4-0": "audio", "5-0": "cad", "6-0": "flash", "7-0": "code", "2-1": "pdfs, google docs etc", "1-1": "link to an external resource", "0-1": "jpeg, gif, png, bmp etc", "3-1": "flv, webm, mp4, wmv etc", "4-1": "mp3, wav, m4a etc", "5-1": "Computer Aided Design files", "6-1": "swf files", "7-1": "py, js, java etc" }, "cols": 2, "rows": 8 } [/block]
{"_id":"5640adaea6a9e90d008d8059","excerpt":"","updates":[],"user":"55cc353caeb9ba0d00395305","version":"5608d0e831beb60d001b6542","title":"Get Posts Collection","__v":0,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl -XGET -H 'App-Id: 4705250fa45571490b6e3b55fcd8b08d3377d654c985d7af794b08005c35b892' -H \"Content-type: application/json\" 'http://www.padlet.com/api/0.9/public_posts?padlet_id=1000000&page=2'","name":""}]},"method":"get","params":[{"_id":"5640adaea6a9e90d008d805c","required":false,"desc":"unique id of padlet which posts belong to","default":"","type":"int","name":"padlet_id","in":"query"},{"required":false,"desc":"unique url of padlet which posts belong","default":"","type":"string","name":"padlet_url","in":"query","_id":"5640adaea6a9e90d008d805b"},{"name":"page","in":"query","_id":"5640adaea6a9e90d008d805a","required":false,"desc":"set the page number for paginated results","default":"1","type":"int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"data\": [\n        {\n            \"id\": 84620966,\n            \"subject\": \"Batman\",\n            \"body\": \"<p>Originally named \\\"the Bat-Man,\\\" the character is also referred to by such epithets as the \\\"Caped Crusader\\\", the \\\"Dark Knight\\\", and the \\\"World's Greatest Detective\\\".</p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/7/75/Comic_Art_-_Batman_by_Jim_Lee_%282002%29.png\",\n            \"created_at\": \"2015-12-03T06:01:19.876Z\",\n            \"updated_at\": \"2015-12-03T06:22:41.145Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        },\n        {\n            \"id\": 84621115,\n            \"subject\": \"Iron Man\",\n            \"body\": \"<p><b>Iron Man (Tony Stark) is a fictional superhero appearing in American comic books published byMarvel Comics, as well as its associated media. </b></p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/e/e0/Iron_Man_bleeding_edge.jpg\",\n            \"created_at\": \"2015-12-03T06:05:11.379Z\",\n            \"updated_at\": \"2015-12-03T06:20:12.454Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        },\n        {\n            \"id\": 84621089,\n            \"subject\": \"Captain America\",\n            \"body\": \"<p>Captain America is a fictional superhero appearing in American comic books published byMarvel Comics. </p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/9/91/CaptainAmerica109.jpg\",\n            \"created_at\": \"2015-12-03T06:04:29.665Z\",\n            \"updated_at\": \"2015-12-03T06:20:35.765Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        },\n        {\n            \"id\": 84621054,\n            \"subject\": \"Wonder Woman\",\n            \"body\": \"<p> Wonder Woman is a warrior princess of the Amazons(which are based on the Amazons of Greek mythology) and is known in her homeland as Princess Diana of Themyscira. </p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/8/8c/WonderWoman-Ross.png\",\n            \"created_at\": \"2015-12-03T06:03:53.022Z\",\n            \"updated_at\": \"2015-12-03T06:21:08.411Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        },\n        {\n            \"id\": 84621030,\n            \"subject\": \"Thor\",\n            \"body\": \"<p>Thor, based on the Norse mythological deity of the same name, is the Asgardian god of thunder and possesses the enchanted hammer Mjolnir.</p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/4/41/Thor-272.jpg\",\n            \"created_at\": \"2015-12-03T06:03:06.545Z\",\n            \"updated_at\": \"2015-12-03T06:22:00.942Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        },\n        {\n            \"id\": 84620993,\n            \"subject\": \"Spiderman\",\n            \"body\": \"<p>Spider-Man is a fictional superhero appearing in American comic books published by Marvel Comics existing in its shared universe.</p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/0/0c/Spiderman50.jpg\",\n            \"created_at\": \"2015-12-03T06:02:15.840Z\",\n            \"updated_at\": \"2015-12-03T06:22:17.790Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        },\n        {\n            \"id\": 84620772,\n            \"subject\": \"Superman\",\n            \"body\": \"<p>Superman is widely considered an Americancultural icon and was created by writer Jerry Siegel and artist Joe Shuster in 1933; later, in 1938, the character was sold to Detective Comics, Inc. (later DC Comics).</p>\",\n            \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/e/eb/SupermanRoss.png\",\n            \"created_at\": \"2015-12-03T05:56:22.539Z\",\n            \"updated_at\": \"2015-12-03T06:23:19.653Z\",\n            \"author_id\": 71384074,\n            \"attachment_type\": \"photo\"\n        }\n    ],\n    \"meta\": {\n        \"current_page\": 1,\n        \"total_pages\": 1,\n        \"total_entries\": 7,\n        \"per_page\": 20\n    }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/public_posts"},"githubsync":"","link_url":"","slug":"get-posts-collection","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Headers\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Content-Type\",\n    \"h-0\": \"name\",\n    \"h-1\": \"description\",\n    \"h-2\": \"type\",\n    \"0-1\": \"indicates the media type\",\n    \"1-0\": \"App-Id\",\n    \"1-1\": \"App-Id from the developer panel of your dashboard\",\n    \"h-3\": \"required?\",\n    \"0-2\": \"string\",\n    \"0-3\": \"true\",\n    \"1-2\": \"string\",\n    \"1-3\": \"true\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"'application/json'\",\n    \"1-4\": \"None\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Filter Parmeters\"\n}\n[/block]\nEndpoint requires one of the following filter parameters.  \nEndpoint only accepts one filter parameter, and will match the first valid parameter found.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"parameters\",\n    \"h-1\": \"description\",\n    \"0-0\": \"padlet_id\",\n    \"0-1\": \"id of padlet that the posts belong to\",\n    \"h-2\": \"type\",\n    \"0-2\": \"integer\",\n    \"h-3\": \"required?\",\n    \"0-3\": \"\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"None\",\n    \"1-0\": \"padlet_url\",\n    \"1-1\": \"url of padlet that posts belong to\",\n    \"1-2\": \"string\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","createdAt":"2015-11-09T14:29:02.096Z","editedParams2":true,"hidden":false,"link_external":false,"type":"get","category":"5640a94ad4b2e00d00bb3cbf","editedParams":true,"order":1,"project":"56035b550c78b00d0039af2f","sync_unique":"","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet Posts Collection


Query Params

padlet_id:
integer
unique id of padlet which posts belong to
padlet_url:
string
unique url of padlet which posts belong
page:
integer1
set the page number for paginated results
[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Filter Parmeters" } [/block] Endpoint requires one of the following filter parameters. Endpoint only accepts one filter parameter, and will match the first valid parameter found. [block:parameters] { "data": { "h-0": "parameters", "h-1": "description", "0-0": "padlet_id", "0-1": "id of padlet that the posts belong to", "h-2": "type", "0-2": "integer", "h-3": "required?", "0-3": "", "h-4": "default value", "0-4": "None", "1-0": "padlet_url", "1-1": "url of padlet that posts belong to", "1-2": "string" }, "cols": 3, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Filter Parmeters" } [/block] Endpoint requires one of the following filter parameters. Endpoint only accepts one filter parameter, and will match the first valid parameter found. [block:parameters] { "data": { "h-0": "parameters", "h-1": "description", "0-0": "padlet_id", "0-1": "id of padlet that the posts belong to", "h-2": "type", "0-2": "integer", "h-3": "required?", "0-3": "", "h-4": "default value", "0-4": "None", "1-0": "padlet_url", "1-1": "url of padlet that posts belong to", "1-2": "string" }, "cols": 3, "rows": 2 } [/block]
{"_id":"565fdcf8bca87d0d006bc7bf","link_url":"","order":999,"project":"56035b550c78b00d0039af2f","title":"Get Post Object","__v":0,"createdAt":"2015-12-03T06:11:04.917Z","editedParams2":true,"excerpt":"","link_external":false,"type":"get","api":{"results":{"codes":[{"code":"{\n    \"data\": {\n        \"id\": 84620966,\n        \"subject\": \"Batman\",\n        \"body\": \"<p>Originally named \\\"the Bat-Man,\\\" the character is also referred to by such epithets as the \\\"Caped Crusader\\\", the \\\"Dark Knight\\\", and the \\\"World's Greatest Detective\\\".</p>\",\n        \"attachment\": \"https://upload.wikimedia.org/wikipedia/en/7/75/Comic_Art_-_Batman_by_Jim_Lee_%282002%29.png\",\n        \"created_at\": \"2015-12-03T06:01:19.876Z\",\n        \"updated_at\": \"2015-12-03T06:22:41.145Z\",\n        \"author_id\": 71384074,\n        \"attachment_type\": \"photo\"\n    }\n}","language":"json","status":200,"name":""},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/public_posts/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -XGET -H 'App-Id: 4705250fa45571490b6e3b55fcd8b08d3377d654c985d7af794b08005c35b892' -H \"Content-type: application/json\" 'https://padlet.com/api/0.9/public_posts/84620966'","name":""}]},"method":"get","params":[{"_id":"565fdcf8bca87d0d006bc7c0","required":false,"desc":"unique id of the post","default":"","type":"int","name":"id","in":"path"}]},"category":"5640a94ad4b2e00d00bb3cbf","githubsync":"","slug":"get-post-object","sync_unique":"","updates":[],"version":"5608d0e831beb60d001b6542","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Required Headers\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Content-Type\",\n    \"h-0\": \"name\",\n    \"h-1\": \"description\",\n    \"h-2\": \"type\",\n    \"0-1\": \"indicates the media type\",\n    \"1-0\": \"App-Id\",\n    \"1-1\": \"App-Id from the developer panel of your dashboard\",\n    \"h-3\": \"required?\",\n    \"0-2\": \"string\",\n    \"0-3\": \"true\",\n    \"1-2\": \"string\",\n    \"1-3\": \"true\",\n    \"h-4\": \"default value\",\n    \"0-4\": \"'application/json'\",\n    \"1-4\": \"None\"\n  },\n  \"cols\": 5,\n  \"rows\": 2\n}\n[/block]","editedParams":true,"hidden":false,"user":"55cc353caeb9ba0d00395305","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet Post Object


Path Params

id:
integer
unique id of the post
[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/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 }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:api-header] { "type": "basic", "title": "Required Headers" } [/block] [block:parameters] { "data": { "0-0": "Content-Type", "h-0": "name", "h-1": "description", "h-2": "type", "0-1": "indicates the media type", "1-0": "App-Id", "1-1": "App-Id from the developer panel of your dashboard", "h-3": "required?", "0-2": "string", "0-3": "true", "1-2": "string", "1-3": "true", "h-4": "default value", "0-4": "'application/json'", "1-4": "None" }, "cols": 5, "rows": 2 } [/block]