With this endpoint you can get a list of your donations. The default output is JSON.\nFor results in a CSV file please extend the url with .csv\nIf you use time filter please note that this is used by default to the 'updated_iso' field. If you wish to use it to the 'created_iso' field please use filter_by parameter.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "kind": "required", "name": "Authorization", "type": "string", "description": "To authentificate please use your API-KEY created here https://iam.ticketpay.de/api-keys. Please give this API-KEY the role Export.
" } ], "queryParameters": [ { "kind": "optional", "name": "from", "type": "string", "example": "2025-05-01T00:00:00.000", "description": "A date or datetime parameter to select the data start with this date. In default this filter is used in the field updated_iso.
" }, { "kind": "optional", "name": "to", "type": "string", "example": "2025-05-05", "description": "A date or datetime parameter to select the data end with this date. In default this filter is used in the field updated_iso.
" }, { "kind": "optional", "name": "filter_by", "type": "string", "example": "created_iso", "description": "Datetime filter field. Default value is updated_iso. Possible values are created_iso and updated_iso
" }, { "kind": "optional", "name": "time_period", "type": "string", "description": "If you dont want to use from and to you can use a time period to select data with a special period. Possible values are months, days, hours, minutes, seconds
" }, { "kind": "optional", "name": "time_range", "type": "integer", "description": "A time range is needed if you use the time_period parameter to select data. For exapmle you want tho get the last two months - time_period is months and time_range is 2
" }, { "kind": "optional", "name": "id", "type": "integer", "description": "To filter the results you can pass here the id of your paid donation" }, { "kind": "optional", "name": "shop_order_id", "type": "integer", "description": "To filter the results you can pass here the id of your order" }, { "kind": "optional", "name": "shop_id", "type": "integer", "description": "To filter the results you can pass here the shop_id of your organizer shop
" }, { "kind": "optional", "name": "event_id", "type": "integer", "description": "To filter the results you can pass here the event_id of one out yours events
" }, { "kind": "optional", "name": "per_page", "type": "integer", "description": "For pagination. Defines the number of data per page in the output." }, { "kind": "optional", "name": "page", "type": "integer", "description": "For pagination. Defines the page number for the data output." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Response for get donations.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "get_donations", "schema": [ { "name": "total", "kind": "optional", "type": "integer", "description": "", "example": 1625 }, { "name": "page", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "size", "kind": "optional", "type": "integer", "description": "", "example": 1000 }, { "name": "data", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 2929 }, { "name": "shop_id", "kind": "optional", "type": "integer", "description": "", "example": 14669 }, { "name": "event_id", "kind": "optional", "type": "integer", "description": "", "example": 78001 }, { "name": "shop_order_id", "kind": "optional", "type": "integer", "description": "", "example": 431113 }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Unicef Donation" }, { "name": "status", "kind": "optional", "type": "string", "description": "", "example": "approved" }, { "name": "amount", "kind": "optional", "type": "float", "description": "", "example": 20 }, { "name": "donation_id", "kind": "optional", "type": "integer", "description": "", "example": 7609 }, { "name": "created_iso", "kind": "optional", "type": "string", "description": "", "example": "2022-02-26T19:29:42+01:00" }, { "name": "updated_iso", "kind": "optional", "type": "string", "description": "", "example": "2022-02-26T19:29:43+01:00" } ] } ], "modelRef": "#/components/schemas/get_donations", "isExpanded": true } ] }, { "statusCode": "401", "description": "Response for a failed authentification.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "not_authorized", "schema": [ { "name": "message", "kind": "optional", "type": "string", "description": "", "example": "Unauthorized" } ], "modelRef": "#/components/schemas/not_authorized", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "_1t03lNV9Vdr9MBjNkNw1", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://tnapi.ticketpay.de/exports/paid_donations \\\n --header 'accept: application/json' \\\n --header 'authorization: string'" }, { "id": "z9aoNAmWg0CuLtgJ0X552", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"authorization\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://tnapi.ticketpay.de/exports/paid_donations\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "MszoDFy3Z75dKZlxUz6Gq", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://tnapi.ticketpay.de/exports/paid_donations\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"authorization\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "PpK0yIrYoGSVsyBi_rb0w", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://tnapi.ticketpay.de/exports/paid_donations\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'authorization': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "_1t03lNV9Vdr9MBjNkNw1" }, "results": { "languages": [ { "id": "HsFLnO6UzUEGKebhd8mxN", "language": "200", "code": "// Response for get donations.\n{\n \"total\": 1625,\n \"page\": 1,\n \"size\": 1000,\n \"data\": [\n {\n \"id\": 2929,\n \"shop_id\": 14669,\n \"event_id\": 78001,\n \"shop_order_id\": 431113,\n \"name\": \"Unicef Donation\",\n \"status\": \"approved\",\n \"amount\": 20,\n \"donation_id\": 7609,\n \"created_iso\": \"2022-02-26T19:29:42+01:00\",\n \"updated_iso\": \"2022-02-26T19:29:43+01:00\"\n }\n ]\n}" }, { "id": "2X4pTyOgJQytE8_DANOj3", "language": "401", "code": "// Response for a failed authentification.\n{\n \"message\": \"Unauthorized\"\n}" } ], "selectedLanguageId": "HsFLnO6UzUEGKebhd8mxN" } }, "children": [ { "text": "" } ] }