{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/pages.json","auth":"required","settings":"","results":{"codes":[{"status":200,"language":"xml","code":"{\n    \"hasMore\":true,\n    \"data\":[\n        {\n            \"id\":123,\n            ...\n        },\n        {\n            \"id\":124,\n            ...\n        },\n        {\n            \"id\":125,\n            ...\n        }\n    ]\n}","name":""}]},"method":"get","examples":{"codes":[]},"params":[{"name":"page","type":"int","default":"1","desc":"page number","required":false,"in":"query","ref":"","_id":"5cbeffb1862d090013abd771"},{"name":"perPage","type":"int","default":"100","desc":"number of objects per page","required":false,"in":"query","ref":"","_id":"5cd4379ed9d25c01cc78cb5b"}]},"next":{"description":"","pages":[]},"title":"/pages.json","type":"endpoint","slug":"pages-list","excerpt":"Returns a collection of fundraising pages that fits to a given criteria array.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Pagination\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\\n\\n(with pagination: /pages.json?page={page_number})\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Filter by criteria\"\n}\n[/block]\nGET /pages.json?received_min={value}&page={page_number}\n\nReturns a collection of fundraising pages that fits to the given criteria.\n\nThese criteria are currently available: \n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Criterion\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"date_min\",\n    \"1-0\": \"date_max\",\n    \"2-0\": \"expires_min\",\n    \"3-0\": \"expires_max\",\n    \"4-0\": \"goal_min\",\n    \"5-0\": \"goal_max\",\n    \"6-0\": \"received_min\",\n    \"7-0\": \"received_max\",\n    \"8-0\": \"received_percentage_min\",\n    \"9-0\": \"received_percentage_max\",\n    \"10-0\": \"status\",\n    \"11-0\": \"fb_person_id\",\n    \"12-0\": \"person\",\n    \"13-0\": \"title\",\n    \"14-0\": \"fb_project_id\",\n    \"15-0\": \"addon_id\",\n    \"16-0\": \"ids (separated by commas)\",\n    \"17-0\": \"search_id\",\n    \"17-1\": \"The ID of a smart search\",\n    \"16-1\": \"A comma separated list of IDs\",\n    \"16-2\": \"string\",\n    \"17-2\": \"integer\",\n    \"15-2\": \"integer\",\n    \"14-2\": \"integer\",\n    \"11-2\": \"integer\",\n    \"4-2\": \"float\",\n    \"5-2\": \"float\",\n    \"6-2\": \"float\",\n    \"7-2\": \"float\",\n    \"8-2\": \"float\",\n    \"9-2\": \"float\",\n    \"10-2\": \"Enum (\\\"not_approved\\\", \\\"locked\\\", \\\"active\\\", \\\"preferred\\\")\",\n    \"0-2\": \"date\",\n    \"1-2\": \"date\",\n    \"2-2\": \"date\",\n    \"3-2\": \"date\",\n    \"13-2\": \"string\",\n    \"12-2\": \"string\",\n    \"12-1\": \"The name of the fundraiser\",\n    \"13-1\": \"The title of the page\",\n    \"14-1\": \"An ID of a project\",\n    \"15-1\": \"An ID of a fundraising page addon\",\n    \"11-1\": \"An ID of a person\",\n    \"4-1\": \"Minimum goal\",\n    \"5-1\": \"Maximum goal\",\n    \"6-1\": \"Minimum received amount\",\n    \"7-1\": \"Maximum received amount\",\n    \"8-1\": \"Minimum received percentage\",\n    \"9-1\": \"Maximum received percentage\",\n    \"10-1\": \"Status of the page\",\n    \"0-1\": \"Minimum creation date of the page\",\n    \"1-1\": \"Maximum creation date of the page\",\n    \"2-1\": \"Minimum expiry date of the page\",\n    \"3-1\": \"Maximum expiry date of the page\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no fundraising page with these criteria exist, an empty fundraising pages container will be returned.\"\n}\n[/block]","updates":[],"order":14,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbeeab508f1cf000e6f203f","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-23T10:36:37.771Z","__v":12,"parentDoc":null}

get/pages.json

Returns a collection of fundraising pages that fits to a given criteria array.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer1
page number
perPage:
integer100
number of objects per page

Result Format


Documentation

[block:callout] { "type": "info", "title": "Pagination", "body": "Maximum is 100 entries, use the page parameter to get the next results.\n\n(with pagination: /pages.json?page={page_number})" } [/block] [block:api-header] { "title": "Filter by criteria" } [/block] GET /pages.json?received_min={value}&page={page_number} Returns a collection of fundraising pages that fits to the given criteria. These criteria are currently available: [block:parameters] { "data": { "h-0": "Criterion", "h-1": "Description", "h-2": "Type", "0-0": "date_min", "1-0": "date_max", "2-0": "expires_min", "3-0": "expires_max", "4-0": "goal_min", "5-0": "goal_max", "6-0": "received_min", "7-0": "received_max", "8-0": "received_percentage_min", "9-0": "received_percentage_max", "10-0": "status", "11-0": "fb_person_id", "12-0": "person", "13-0": "title", "14-0": "fb_project_id", "15-0": "addon_id", "16-0": "ids (separated by commas)", "17-0": "search_id", "17-1": "The ID of a smart search", "16-1": "A comma separated list of IDs", "16-2": "string", "17-2": "integer", "15-2": "integer", "14-2": "integer", "11-2": "integer", "4-2": "float", "5-2": "float", "6-2": "float", "7-2": "float", "8-2": "float", "9-2": "float", "10-2": "Enum (\"not_approved\", \"locked\", \"active\", \"preferred\")", "0-2": "date", "1-2": "date", "2-2": "date", "3-2": "date", "13-2": "string", "12-2": "string", "12-1": "The name of the fundraiser", "13-1": "The title of the page", "14-1": "An ID of a project", "15-1": "An ID of a fundraising page addon", "11-1": "An ID of a person", "4-1": "Minimum goal", "5-1": "Maximum goal", "6-1": "Minimum received amount", "7-1": "Maximum received amount", "8-1": "Minimum received percentage", "9-1": "Maximum received percentage", "10-1": "Status of the page", "0-1": "Minimum creation date of the page", "1-1": "Maximum creation date of the page", "2-1": "Minimum expiry date of the page", "3-1": "Maximum expiry date of the page" }, "cols": 3, "rows": 18 } [/block] [block:callout] { "type": "info", "body": "If no fundraising page with these criteria exist, an empty fundraising pages container will be returned." } [/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 }}