{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/donations.json","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"hasMore\":true,\n    \"data\":[\n        {\n            \"id\":123,\n          \t...\n        },\n      \t{\n            \"id\":124,\n          \t...\n        },\n      \t{\n            \"id\":125,\n          \t...\n        }\n\t\t]\n}","name":""}]},"method":"get","examples":{"codes":[]},"settings":"","params":[{"name":"page","type":"int","default":"1","desc":"page number","required":false,"in":"query","ref":"","_id":"5cbeff96dc66db0019b9017f"},{"name":"perPage","type":"int","default":"100","desc":"number of objects per page","required":false,"in":"query","ref":"","_id":"5cd436867ca69b035435cdda"}]},"next":{"description":"","pages":[]},"title":"/donations.json","type":"endpoint","slug":"donations-list","excerpt":"Returns a collection of confirmed donations that fits to a given criteria array.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\\n\\n(with pagination: /donations.json?page={page_number})\",\n  \"title\": \"Pagination\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Filter by criteria\"\n}\n[/block]\nGET /donations.json?amount_min={value}&page={page_number}\n\nReturns a collection of donations that fits to the given criteria.\n\nThese criteria are currently available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Criterion\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"0-0\": \"amount_min\",\n    \"1-0\": \"amount_max\",\n    \"2-0\": \"date_min\",\n    \"3-0\": \"date_max\",\n    \"4-0\": \"received_min\",\n    \"5-0\": \"received_max\",\n    \"6-0\": \"ident_id_min\",\n    \"7-0\": \"ident_id_max\",\n    \"8-0\": \"receipt_status\",\n    \"9-0\": \"fb_project_id\",\n    \"10-0\": \"fb_type_id\",\n    \"11-0\": \"fb_source_id\",\n    \"12-0\": \"fb_person_id\",\n    \"13-0\": \"fb_payment_form_configuration_id\",\n    \"14-0\": \"fb_payout_id\",\n    \"15-0\": \"ids (separated by commas)\",\n    \"16-0\": \"search_id\",\n    \"0-2\": \"float\",\n    \"1-2\": \"float\",\n    \"6-2\": \"integer\",\n    \"7-2\": \"integer\",\n    \"9-2\": \"integer\",\n    \"10-2\": \"integer\",\n    \"11-2\": \"integer\",\n    \"12-2\": \"integer\",\n    \"13-2\": \"integer\",\n    \"14-2\": \"integer\",\n    \"16-2\": \"integer\",\n    \"16-1\": \"The ID of a smart search\",\n    \"15-1\": \"A comma separated list of IDs\",\n    \"14-1\": \"The ID of a payout object\",\n    \"9-1\": \"The ID of a project\",\n    \"12-1\": \"The ID of a person\",\n    \"13-1\": \"The ID of a payment form\",\n    \"11-1\": \"The ID of a source\",\n    \"10-1\": \"The ID of a payment type\",\n    \"8-2\": \"Enum (\\\"receipt_now\\\", \\\"no_receipt\\\", \\\"receipt_end_of_year\\\", \\\"receipt_sent\\\", \\\"receipt_never\\\")\",\n    \"8-1\": \"Wish for donation receipt\",\n    \"0-1\": \"Minimum amount\",\n    \"1-1\": \"Maximum amount\",\n    \"2-1\": \"Minimum donation date\",\n    \"4-1\": \"Minimum received date\",\n    \"6-1\": \"Minimum ident id\",\n    \"5-1\": \"Maximum received date\",\n    \"3-1\": \"Maximum donation date\",\n    \"2-2\": \"date\",\n    \"3-2\": \"date\",\n    \"4-2\": \"date\",\n    \"5-2\": \"date\",\n    \"15-2\": \"string\",\n    \"7-1\": \"Maximum ident id\"\n  },\n  \"cols\": 3,\n  \"rows\": 17\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no donations with these criteria exist, an empty donation container will be returned.\"\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbee16f367a350039ad68d1","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-23T09:57:03.093Z","__v":11,"parentDoc":null}

get/donations.json

Returns a collection of confirmed donations 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", "body": "Maximum is 100 entries, use the page parameter to get the next results.\n\n(with pagination: /donations.json?page={page_number})", "title": "Pagination" } [/block] [block:api-header] { "title": "Filter by criteria" } [/block] GET /donations.json?amount_min={value}&page={page_number} Returns a collection of donations 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": "amount_min", "1-0": "amount_max", "2-0": "date_min", "3-0": "date_max", "4-0": "received_min", "5-0": "received_max", "6-0": "ident_id_min", "7-0": "ident_id_max", "8-0": "receipt_status", "9-0": "fb_project_id", "10-0": "fb_type_id", "11-0": "fb_source_id", "12-0": "fb_person_id", "13-0": "fb_payment_form_configuration_id", "14-0": "fb_payout_id", "15-0": "ids (separated by commas)", "16-0": "search_id", "0-2": "float", "1-2": "float", "6-2": "integer", "7-2": "integer", "9-2": "integer", "10-2": "integer", "11-2": "integer", "12-2": "integer", "13-2": "integer", "14-2": "integer", "16-2": "integer", "16-1": "The ID of a smart search", "15-1": "A comma separated list of IDs", "14-1": "The ID of a payout object", "9-1": "The ID of a project", "12-1": "The ID of a person", "13-1": "The ID of a payment form", "11-1": "The ID of a source", "10-1": "The ID of a payment type", "8-2": "Enum (\"receipt_now\", \"no_receipt\", \"receipt_end_of_year\", \"receipt_sent\", \"receipt_never\")", "8-1": "Wish for donation receipt", "0-1": "Minimum amount", "1-1": "Maximum amount", "2-1": "Minimum donation date", "4-1": "Minimum received date", "6-1": "Minimum ident id", "5-1": "Maximum received date", "3-1": "Maximum donation date", "2-2": "date", "3-2": "date", "4-2": "date", "5-2": "date", "15-2": "string", "7-1": "Maximum ident id" }, "cols": 3, "rows": 17 } [/block] [block:callout] { "type": "info", "body": "If no donations with these criteria exist, an empty donation 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 }}