Employees

1 min

GET

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

With this endpoint you can get a list of your employees if you use our accreditation system. 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 your employee

emailstringTo filter the results you can pass here an email address. The results will put all employees with this email address.

qrcode_valueintegerTo filter the results you can pass here the qrcode value of a checkin media of your employee

project_idintegerTo filter the results you can pass here the pproject_id of one of your projects

partner_idintegerTo filter the results you can pass here the partner_id of one of your partners

profile_idintegerTo filter the results you can pass here the profile_id of one of your access profiles

statusstringTo filter the results you can pass here the status of vouchers. The results will put all vouchers with this status.

per_pageintegerFor pagination. Defines the number of data per page in the output.

pageintegerFor pagination. Defines the page number for the data output.

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 employees.

401Response for a failed authentification.

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