Skip to content
TixFin

API Documentation

Complete API Reference

REST API with OpenAPI documentation, typed responses, and official clients for TypeScript and Python.

Request API accessAPI Clients

Read-only

Core Endpoints

Every endpoint the Partner API serves today, under one project-scoped base path. Lists are paginated with page and size (up to 100 per page).

Base path
/api/partner/projects/{projectId}
  • GET/events

    List the project's events with schedule, status and sales state.

    Key scope: events.read

  • GET/events/{eventId}

    Retrieve one event, including sales pause, operations notice and refund deadline.

    Key scope: events.read

  • GET/ticket-catalog?eventId=

    List ticket types with price, currency, stock, sale start and validity window.

    Key scope: ticket_catalog.read

  • GET/tickets?eventId=&paymentReference=&status=

    List issued tickets, filterable by event, payment reference and status.

    Key scope: tickets.read

  • GET/orders?eventId=

    List orders grouped by payment reference, with total, ticket count and statuses.

    Key scope: orders.read

Authentication

One key, one project

API keys are created per project in Settings → Integrations and shown once, in prefix.secret format.

  • Send the key as an X-API-Key header or as an Authorization: Bearer token.
  • Each key is scoped to endpoint groups; a call outside its scope returns 403.
  • Keys can be rotated or revoked at any time, with an audit trail of every change.
request.shShell
curl "https://rest-api.tixfin.com/api/partner/projects/{projectId}/events?page=0&size=20" \
  -H "X-API-Key: YOUR_API_KEY"

Built in

API Features

  • REST API

    Clean, read-only RESTful endpoints following consistent conventions across all resources.

  • API-Key Authentication

    Project-scoped keys with endpoint-group permissions, rotation and revocation.

  • Pagination

    Every list returns items with total, page and size, so large exports stay predictable.

  • Rate Limiting

    Limits per IP and per API key protect the platform. Generous limits for standard usage.

  • OpenAPI Spec

    A full OpenAPI schema and Swagger UI served by the API itself — the source both official clients are built from.

  • Structured Errors

    Consistent JSON error responses carrying the HTTP status and a descriptive message.

Ready to Integrate?

Partner API access is enabled per project during the beta. Tell us what you want to connect.