Skip to main content

TIXY Public Organizer API Quickstart

Overview

The TIXY Public Organizer API provides public access to event and tour data, allowing you to retrieve information about published and past due events and tours.

Authentication

The API uses Bearer token authentication. You’ll need to include an authorization token in the request header:
Authorization: Bearer YOUR_ACCESS_TOKEN

Obtaining Access Token

Obtain your public API access token in your panel on TIXY platform. Each token is unique to your organization and provides secure access to your public event data.

Base URL

https://public-api.tixyapp.com

Available Endpoints

Events

Retrieve Events by Status

GET /events/{status} Retrieve a list of events filtered by their status. Path Parameters:
  • status: Filter events by their current state
    • all: Retrieve all events
    • published: Retrieve currently published events
    • pastdue: Retrieve past due events
Example Request:
curl https://public-api.tixyapp.com/events/published \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response:
[
  {
    "id": "event123",
    "name": "Summer Music Festival",
    "date": "2024-07-15T19:00:00Z",
    "location": "City Park Arena",
    "description": "Annual summer music celebration",
    "status": "published"
  }
]

Retrieve Specific Event Details

GET /event/{id} Retrieve details for a specific event by its unique identifier or slug. Path Parameters:
  • id: Unique identifier or slug of the event
Example Request:
curl https://public-api.tixyapp.com/event/summer-music-festival \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response:
{
  "id": "event123",
  "name": "Summer Music Festival",
  "date": "2024-07-15T19:00:00Z",
  "location": "City Park Arena",
  "description": "Annual summer music celebration",
  "status": "published"
}

Tours

Retrieve Tours by Status

GET /tours/{status} Retrieve a list of tours filtered by their status. Path Parameters:
  • status: Filter tours by their current state
    • all: Retrieve all tours
    • published: Retrieve currently published tours
    • pastdue: Retrieve past due tours
Example Request:
curl https://public-api.tixyapp.com/tours/published \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response:
[
  {
    "id": "tour456",
    "name": "Summer Concert Series",
    "events": [
      {
        "id": "event123",
        "name": "Summer Music Festival",
        "date": "2024-07-15T19:00:00Z",
        "location": "City Park Arena",
        "status": "published"
      }
    ],
    "description": "A series of summer music events",
    "status": "published"
  }
]

Retrieve Specific Tour Details

GET /tour/{id} Retrieve details for a specific tour by its unique identifier or slug. Path Parameters:
  • id: Unique identifier or slug of the tour
Example Request:
curl https://public-api.tixyapp.com/tour/summer-concert-series \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Example Response:
{
  "id": "tour456",
  "name": "Summer Concert Series",
  "events": [
    {
      "id": "event123",
      "name": "Summer Music Festival",
      "date": "2024-07-15T19:00:00Z",
      "location": "City Park Arena",
      "status": "published"
    }
  ],
  "description": "A series of summer music events",
  "status": "published"
}

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests:
  • 200 OK: Successful request
  • 400 Bad Request: Invalid parameters or malformed request
  • 404 Not Found: Requested resource does not exist
  • 500 Internal Server Error: Unexpected server-side error
Example Error Response:
{
  "message": "Event not found",
  "code": "NOT_FOUND"
}

Rate Limiting

Please be mindful of the API’s rate limits. Excessive requests may result in temporary blocking of your access token.

Setting up

Avaliable APIs