REST API

This part of the documentation contains information about the REST-style API exposed by pretix since version 1.5 that can be used by third-party programs to interact with pretix and its data structures.

• Basic concepts
  • Authentication
  • Permissions
  • Compatibility
  • Pagination
  • Conditional fetching
  • Errors
  • Data types
  • Idempotency
  • File upload
• Authentication
  • Token-based authentication
  • OAuth authentication / “Connect with pretix”
  • Device authentication
• Resources and endpoints
  • Organizers
  • Events
  • Event series dates / Sub-events
  • Tax rules
  • Item categories
  • Items
  • Item variations
  • Item bundles
  • Item add-ons
  • Questions
  • Question options
  • Quotas
  • Orders
  • Invoices
  • Vouchers
  • Discounts
  • Check-in
  • Check-in lists
  • Waiting list entries
  • Customers
  • Membership types
  • Memberships
  • Gift cards
  • Cart positions
  • Teams
  • Devices
  • Webhooks
  • Seating plans
  • Data exporters
  • Data shredders
  • Automated email rules
  • pretix Hosted billing invoices
  • pretix Hosted reseller API
• Rate limiting
• Webhooks
  • Configuring webhooks
  • Receiving webhooks
  • Responding to a webhook
  • Debugging webhooks
• API Usage Guides
  • Understanding the life cycle of orders
  • Creating an external checkout process