{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v1/feeds?offset=0&limit=10","auth":"required","examples":{"codes":[{"code":"curl -X GET -H \"X-Api-Key: YOUR_API_KEY\" \"https://api.pushapps.mobi/v1/feeds?offset=0&limit=10\"","language":"curl"}]},"method":"get","params":[{"name":"offset","type":"int","default":"0","desc":"result offset, sorted by create date in descending order","required":false,"in":"query","ref":"","_id":"56eb2b3c9b984b290021368b"},{"name":"limit","type":"int","default":"20","desc":"maximum amount of feeds to return","required":false,"in":"query","ref":"","_id":"56eb2b3c9b984b290021368a"}],"results":{"codes":[{"name":"","code":"{\n  \"feeds\": [\n    {\n      \"id\": \"568e76142da06406417523c1\",\n      \"url\": \"http://blog.pushapps.mobi/rss/\",\n      \"status\" : \"active\",\n      \"name\": \"PushApps Blog\",\n      \"created_at\": 1452921850581\n    }\n  ]\n}","language":"json","status":200}]},"settings":""},"next":{"description":"","pages":[]},"title":"/feeds - view feeds","type":"endpoint","slug":"feeds","excerpt":"","body":"result is an array with the key `feeds`:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"url\",\n    \"2-0\": \"name\",\n    \"3-0\": \"status\",\n    \"4-0\": \"created_at\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"number\",\n    \"0-2\": \"the id of the feed, you need to use this id in other endpoints that take feed id\",\n    \"1-2\": \"the url of the feed. needs to be an RSS or JSON feed url.\",\n    \"2-2\": \"the display name of the feed\",\n    \"3-2\": \"current status, possible values:\\n* `active`\\n* `disabled`\",\n    \"4-2\": \"the create date of the feed in unix timestamp in [ms]\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56ea8db9ed3ad20e004e5a02","category":{"sync":{"isSync":false,"url":""},"pages":["56e590ae69d7890e000ec286","56e590fa3c29b117008dae50","56e6f058d66be417007d2364","56e7eaa8f0fafd36008faf59","56ea8db9ed3ad20e004e5a02","56ea8f3e0252fb17008804ac"],"title":"Server API","slug":"remote-api","order":7,"from_sync":false,"reference":false,"_id":"56e5362775eb791700a9c4d2","__v":6,"createdAt":"2016-03-13T09:43:03.596Z","project":"56cecbdb44c5700b0095c03a","version":"56cecbdc44c5700b0095c03d"},"user":"56cecbb2e50c9c1b008303eb","__v":2,"editedParams":true,"createdAt":"2016-03-17T10:58:01.104Z","editedParams2":true,"githubsync":"","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56cecbdc44c5700b0095c03e","56d1d2c05ad7ad0b00b7e809","56d1d2fa5ad7ad0b00b7e80a","56d369331660770b00081159","56d3693d1660770b0008115a","56e5361e7990160e002e3fbc","56e5362775eb791700a9c4d2","57a9030947f2f419009188d4","57b4705ee9e4c60e00f6f4c3","5828f5b04774ab0f005179a2"],"_id":"56cecbdc44c5700b0095c03d","project":"56cecbdb44c5700b0095c03a","__v":10,"createdAt":"2016-02-25T09:39:40.121Z","releaseDate":"2016-02-25T09:39:40.121Z"},"project":"56cecbdb44c5700b0095c03a","parentDoc":null}

get/feeds - view feeds


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

offset:
integer0
result offset, sorted by create date in descending order
limit:
integer20
maximum amount of feeds to return

Examples


Result Format


Documentation

result is an array with the key `feeds`: [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "id", "1-0": "url", "2-0": "name", "3-0": "status", "4-0": "created_at", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "string", "4-1": "number", "0-2": "the id of the feed, you need to use this id in other endpoints that take feed id", "1-2": "the url of the feed. needs to be an RSS or JSON feed url.", "2-2": "the display name of the feed", "3-2": "current status, possible values:\n* `active`\n* `disabled`", "4-2": "the create date of the feed in unix timestamp in [ms]" }, "cols": 3, "rows": 5 } [/block]