{"__v":3,"_id":"571f9b38ebdbad1700a0c832","category":{"project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","_id":"571f7fb0ac2a080e0014c661","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-26T14:48:16.712Z","from_sync":false,"order":7,"slug":"rest-api","title":"REST-API"},"parentDoc":null,"project":"571f5e8cd8667f0e00a3c498","user":"571f5e46d8e3cf1900762b33","version":{"__v":12,"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"hasReference":true,"project":"571f5e8cd8667f0e00a3c498","createdAt":"2016-04-26T12:26:52.312Z","releaseDate":"2016-04-26T12:26:52.312Z","categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-26T16:45:44.133Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"<fb_recurring_payments>\n   <fb_recurring_payment>...</fb_recurring_payment>\n   <fb_recurring_payment>...</fb_recurring_payment>\n</fb_recurring_payments>","language":"xml","status":200}]},"settings":"","auth":"required","params":[],"url":"/recurrings.xml"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"\",\n  \"body\": \"Maximum is 100 entries, use the page parameter to get the next results.\"\n}\n[/block]\nGET /recurrings.xml?criteria[amount_min]={value}&page={page_number}\n\nThese criteria are currently available:\n\n    show\n    type\n    amount_min\n    amount_max\n    start_min\n    start_max\n    next_min\n    next_max\n    interval\n    fb_project_id\n    fb_type_id\n    fb_source_id\n    fb_payment_form_configuration_id\n    fb_person_id\n    ids (separated by comma)\n    search_id (smart-search id)\n\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If no recurring payments with these criteria exist, an empty recurring payment container will be returned.\"\n}\n[/block]","excerpt":"Returns a collection of recurring payments that fits to a given criteria array.","slug":"recurringsxml","type":"endpoint","title":"/recurrings.xml"}

get/recurrings.xml

Returns a collection of recurring payments that fits to a given criteria array.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

[block:callout] { "type": "info", "title": "", "body": "Maximum is 100 entries, use the page parameter to get the next results." } [/block] GET /recurrings.xml?criteria[amount_min]={value}&page={page_number} These criteria are currently available: show type amount_min amount_max start_min start_max next_min next_max interval fb_project_id fb_type_id fb_source_id fb_payment_form_configuration_id fb_person_id ids (separated by comma) search_id (smart-search id) [block:callout] { "type": "info", "body": "If no recurring payments with these criteria exist, an empty recurring payment 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 }}