API Overview
Integrate TixFin with your website or app
Connect your own systems to TixFin through the Partner API — a read-only, API-key authenticated REST API for pulling a project's events, ticket catalog, tickets, and orders.
TixFin is in beta, and beta is production. The Partner API answers on
https://beta-rest-api.tixfin.com; projects in test mode return test data.
What Can You Do?
Common Use Cases
| Use Case | Description |
|---|---|
| Automation | Sync events, tickets, and orders with your systems |
| Analytics | Pull data for custom reports and dashboards |
| Reconciliation | Match orders and tickets against your own records |
| Custom integrations | Feed TixFin data into a CRM, warehouse, or BI tool |
The Partner API is read-only today. Creating events, selling tickets, and managing check-in happen through the TixFin dashboard, not this API.
Getting Started
1. Get an API Key
prefix.secret format
- Integrations
- Endpoint groups
- Create API key
- Rotate or revoke a key
Keys are project-scoped, and the same page lists existing keys so you can rotate or revoke them, with an Audit trail of those actions. A project can hold at most 50 live keys. Creating, rotating and revoking a key and switching an endpoint group ask for your second factor if you have not confirmed it in the last ten minutes.
2. Make Your First Request
curl https://beta-rest-api.tixfin.com/api/partner/projects/YOUR_PROJECT_ID/events \
-H "X-API-Key: YOUR_API_KEY"API Basics
Base URL
https://beta-rest-api.tixfin.comAll Partner API endpoints are scoped to a project:
/api/partner/projects/{projectId}/...Authentication
Send your API key as either header:
X-API-Key: YOUR_API_KEYor
Authorization: Bearer YOUR_API_KEYSee the Authentication guide for details.
Response Format
List endpoints return a paginated envelope:
{
"items": [ /* ... */ ],
"page": 0,
"size": 20,
"totalItems": 42,
"totalPages": 3
}page starts at 0 and size is 1 to 100 (default 20). Out-of-range values
are clamped, not rejected.
Single-resource endpoints (like GET /events/{eventId}) return the object
directly.
The machine-readable contract is served without a key at
GET /api/partner/openapi.json.
Rate Limits
One limit applies per API key and one per client IP address:
| Scope | Sustained rate | Burst |
|---|---|---|
| Per API key | 10 requests/second (600/minute) | 60 |
| Per IP address | 5 requests/second (300/minute) | 30 |
Exceeding either returns 429 with a Retry-After header.
Endpoints
Every key is scoped to one or more endpoint groups, and the project must
have the group enabled as well. Calling an endpoint whose group is missing on
either side returns 403.
Endpoint group: events.read
List Events
GET /api/partner/projects/{projectId}/events?page=0&size=20Get Event Details
GET /api/partner/projects/{projectId}/events/{eventId}Endpoint group: ticket_catalog.read
List Ticket Catalog Items
GET /api/partner/projects/{projectId}/ticket-catalog?eventId={eventId}&page=0&size=20eventId is optional.
Endpoint group: tickets.read
List Tickets
GET /api/partner/projects/{projectId}/tickets?eventId={eventId}&paymentReference=&status=&page=0&size=20eventId, paymentReference, and status are all optional filters.
status is PAID, SCANNED, SCANNED_OUT or CANCELLED (any case);
another value matches nothing.
Endpoint group: orders.read
List Orders
GET /api/partner/projects/{projectId}/orders?eventId={eventId}&page=0&size=20An "order" is an aggregate over all tickets sharing a paymentReference.
eventId is optional.
The dashboard also lists webhooks.read and webhooks.manage. No partner
endpoint uses them yet: webhooks are set up in the dashboard under Account →
Webhooks — see Webhooks.
Official SDKs
Instead of calling the REST API directly, use one of the official client libraries — both wrap authentication, pagination params, and error handling:
npm install @tixfin/partner-api-clientimport { TixfinPartnerClient } from "@tixfin/partner-api-client";
const client = new TixfinPartnerClient({
projectId: "YOUR_PROJECT_ID",
apiKey: process.env.TIXFIN_PARTNER_API_KEY!,
baseUrl: "https://beta-rest-api.tixfin.com",
});
const events = await client.listEvents();pip install tixfin-partner-apiimport os
from tixfin_partner_api import TixfinPartnerClient
client = TixfinPartnerClient(
project_id="YOUR_PROJECT_ID",
api_key=os.environ["TIXFIN_PARTNER_API_KEY"],
base_url="https://beta-rest-api.tixfin.com",
)
events = client.list_events()Full reference, and what version 0.1.0 does not handle yet: SDKs guide.
Best Practices
✅ Security
- Store keys in environment variables, never in client-side code
- Scope each key to only the endpoint groups it needs
- Rotate keys regularly and revoke unused ones
✅ Performance
- Cache responses when possible
- Use
page/sizeto avoid over-fetching (sizemax is 100) - Filter
tickets/ordersbyeventIdwhen you only need one event
✅ Error Handling
- Check HTTP status codes
- Read the
detailfield in error responses - On
429, wait for theRetry-Afterseconds before retrying
Error Codes
| Code | Meaning |
|---|---|
| 200 | Success |
| 401 | Missing, malformed, revoked or unknown API key |
| 403 | Key issued for another project, key without this endpoint group, or group disabled for the project |
| 404 | Resource not found |
| 429 | Rate limit exceeded (see Retry-After) |
| 500 | Server error (contact support) |
| 501 | This deployment does not serve the endpoint's data yet |
| 502 | The service that owns the data could not be read; retry later |
Error responses look like:
{
"title": "Unauthorized",
"status": 401,
"detail": "Invalid API key.",
"timestamp": "2026-10-25T09:30:00.000000000Z"
}Send Accept-Language: de for German title values.
Support
Documentation:
Need Help?
- Email: api@tixfin.com
- Include: API key prefix (never the full key), request details, error messages
