Cancellations

1 min

GET

https://tnapi.ticketpay.de/exports/cancellations

With this endpoint you can get a list of cancellations, performed in your account. The default output is JSON. For results in a CSV file please extend the url with .csv If 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.

fromstringA date or datetime parameter to select the data start with this date. In default this filter is used in the field updated_iso.

tostringA date or datetime parameter to select the data end with this date. In default this filter is used in the field updated_iso.

filter_bystringDatetime filter field. Default value is updated_iso. Possible values are created_iso and updated_iso

time_periodstringIf 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

time_rangeintegerA 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

idintegerTo filter the results you can pass here the id of one of your cancellations

related_tointegerTo filter the results you can pass here the id of a ticket or order to get the cancellation

event_idintegerTo filter the results you can pass here the event_id of one out yours events

AuthorizationstringTo authentificate please use your API-KEY created here <a href="https://iam.ticketpay.de/api-keys" target="_blank">https://iam.ticketpay.de/api-keys</a>. Please give this API-KEY the role Export.

200Response for get cancellations.

401Response for a failed authentification.

curl --request GET \
     --url https://tnapi.ticketpay.de/exports/cancellations \
     --header 'accept: application/json' \
     --header 'authorization: string'