TickeTing REST API v3 Reference (3.0.0)

Introduction

The TickeTing REST API v3 allows developers to integrate with the TickeTing platform, from creating hosts and events to buying and transferring tickets. This reference document will walk you through authenticating against the API and the full list of available endpoints, their permissions and functionality.

Authentication

The TickeTing API uses API keys to authenticate requests. You must provide a valid API Key in the X-API-Key header of each request you make. There are two ways to get a valid API Key:

Start a session with a valid TickeTing username and password (this gives access based on the user's permissions).
Secure an integration key from a system administrator. Integration keys grant an access level determined by the administrator on creation.

Session Authentication and Integration Keys are covered in the Authentication section of this reference.

Example Request Header

X-API-Key: a9427bf35dd3d3011a1277c9c344ae07

Authentication Errors

Omitting the X-API-Key Header from your request or specifying an empty value, will result in the following 401 error response.

{
  "message": "Your request could not be authenticated."
}

If an invalid X-API-Key value is provided, or the provided key is valid, but does not have permission to access the requested resource, the following 403 error response is sent.

{
  "message": "You are restricted from accessing this resource."
}

Client Version

All requests to the API must advertise the version of the API they wish to integrate with. This ensures compatability with the server. This is done by including the X-Client-Version header in every request along with the expected API version. In this way the server can indicate when a client must upgrade to avoid breaking changes.

Example Request Header

X-Client-Version: 3.0.0

Client Version Errors

If the X-Client-Version header is omitted from your request, or the provided version does not meet the minimum required by the API, the following 412 error response is sent.

{
    "error": "Please upgrade your client to complete this request"
}

Error Responses

404 Errors

Requests to the API can result in a 404 error for two reasons:

The endpoint you are trying to access does not exist, in which case you will see the following response:
```
{
    "message": "The requested endpoint /invalid/endpoint does not exist on this server."
}
```
The endpoint you are requesting exists, but a resource cannot be located using the given URI. For example, trying to access an event resource with a non-existant ID such as /events/0000000 will result in the following response:
```
{
    "error": "There is presently no resource with the given URI."
}
```

Server Errors

This version of the API is still under development and there may be bugs and runtime errors encountered while processing your request. In these cases, a 500 error response will be sent with the message below. If such a message is received, please contact a system administrator with the details of your request (endpoint, method, headers and payload), so they may reproduce and resolve the issue.

{
  "message": "There was a server error while excuting this request. Please see system logs for details."
}

Other Errors

Additional error responses may be received when incorrectly accessing valid API endpoints. The errors received, and their resolution, are specific to the requested URI and HTTP Method and details are provided with each endpoint's reference where applicable.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

TickeTing Inc.

dev@ticketingevents.com

License

Apache 2.0

Servers

Mock server

https://docs.ticketingevents.com/_mock/openapi/

QA Server

https://qa.ticketingevents.com/v3/

Production Server

https://api.ticketingevents.com/v3/

Session Authentication

Operations

Token Authentication

Operations

API Integrations

Operations

Account Management

Operations

Account Verification

Operations

Account Activation

Operations

Password Reset

Operations

Account Activity

Operations

Managing Host Accounts

Operations

Working with Events

Operations

List all published events

Request

Retrieve a list of published events open to the public that match the given criteria.

Query

recordsinteger

The number of records per page that should be returned

Default 25

pageinteger

The number of the results page to return

Default 1

regionstring^\d{14}$

If set, only returns events being hosted in the specified region

titlestring

If set, only returns events whose title matches the specified regular expression

sortstring

If set, determines how the returned events list is sorted

Enum"alphabetical""published""popularity""start"

orderstring

If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order.

Default "asc"

Enum"asc""desc"

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/published-events?order=asc&page=1&records=25&region=string&sort=alphabetical&title=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of published events was successfully retrieved.

Bodyapplication/json

totalinteger

The total number of results available

pageinteger

The number of the results page returned

recordsinteger

The maximum number of results returned per page

entriesArray of objects(response-7)

Response

application/json

{
  "page": 1,
  "records": 25,
  "entries": [
    { … }
  ]
}

List all events

Request

Retrieve a list of events matching the given criteria.

Query

recordsinteger

The number of records per page that should be returned

Default 25

pageinteger

The number of the results page to return

Default 1

regionstring^\d{14}$

If set, only returns events being hosted in the specified region

hoststring^\d{14}$

If set, only returns events being staged by the specified host

titlestring

If set, only returns events whose title matches the specified regular expression

statusstring

If set, only returns events with the specified status

Enum"Draft""Under Review""Scheduled""Listed""Cancelled""Staged"

activeboolean

Only returns future events if set to true, or past events if set to false

publicboolean

Only returns public events if set to true, or private events if set to false.

sectionstring

If set, only returns the event containing the specified section

sortstring

If set, determines how the returned events list is sorted

Enum"alphabetical""published""popularity""start"

orderstring

If set along with the 'sort' parameter, determines whether the results will be sorted in ascending or descending order.

Default "asc"

Enum"asc""desc"

curl -i -X GET \
  'https://docs.ticketingevents.com/_mock/openapi/events?active=true&host=string&order=asc&page=1&public=true&records=25&region=string&section=string&sort=alphabetical&status=Draft&title=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of matching events was successfully retrieved.

Bodyapplication/json

totalinteger

The total number of results available

pageinteger

The number of the results page returned

recordsinteger

The maximum number of results returned per page

entriesArray of objects(response-7)

Response

application/json

{
  "page": 1,
  "records": 25,
  "entries": [
    { … }
  ]
}

Register an event

Request

Register a new event in the TickeTing system. Once submitted for review and approved by an administrator, the host can begin to sell tickets to the event.

Bodyapplication/json

hoststring^\d{14}$required

Unique identifier of the host staging this event

titlestringrequired

Unique name of the event

descriptionstringrequired

Long form text detailing what the event is about, including performing acts, amenities and additional information important to potential attendees

typestringrequired

Nature of the event. Determines what information is collected on ticket purchase.

Enum"Standard""Registration"

publicbooleanrequired

Whether or not the event is open to the general public

categorystring(uri)required

URI of the category under which the event is classified

subcategorystringrequired

Subcategory under which the event is classified

startstring(date-time)

The date and time at which the event is scheduled to begin

endstring(date-time)

The date and time at which the event is scheduled to finish

venuestring(uri)required

URI of the venue at which the event is taking place

disclaimerstring

Subcategory under which the event is classified

tagsArray of strings

List of short phrases that can be used to search and share the event

bannerstring(base64)

Base64 representation of the event's banner image data

thumbnailstring(base64)

Base64 representation of the event's thumbnail image data

curl -i -X POST \
  https://docs.ticketingevents.com/_mock/openapi/events \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "host": "16951985851389",
    "title": "Dawn of the Seven Premier",
    "description": "World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n",
    "type": "Standard",
    "public": true,
    "category": "/categories/16878141745207",
    "subcategory": "Premier",
    "start": "2024-06-07T20:00",
    "end": "2024-06-07T23:00",
    "venue": "/venues/16878146473429",
    "disclaimer": "Attend at your own risk",
    "tags": [
      "homelander",
      "queen maeve",
      "the deep",
      "A-Train"
    ],
    "banner": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAzoAAASRCAYAAAD/zekXAA...",
    "thumbnail": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAB4AAAAQ4CAYAAADo08FDAAAAB...",
    "x-parsed-md-description": {
      "result": [
        {
          "$$mdtype": "Node",
          "errors": [],
          "lines": [
            0,
            2
          ],
          "inline": false,
          "attributes": {},
          "children": [
            {
              "$$mdtype": "Node",
              "errors": [],
              "lines": [
                0,
                2
              ],
              "inline": false,
              "attributes": {},
              "children": [
                {
                  "$$mdtype": "Node",
                  "errors": [],
                  "lines": [
                    0,
                    2
                  ],
                  "inline": true,
                  "attributes": {
                    "content": "World Premier of the long anticipated movie event of the"
                  },
                  "children": [],
                  "type": "text",
                  "annotations": [],
                  "slots": {}
                },
                {
                  "$$mdtype": "Node",
                  "errors": [],
                  "lines": [
                    0,
                    2
                  ],
                  "inline": true,
                  "attributes": {},
                  "children": [],
                  "type": "softbreak",
                  "annotations": [],
                  "slots": {}
                },
                {
                  "$$mdtype": "Node",
                  "errors": [],
                  "lines": [
                    0,
                    2
                  ],
                  "inline": true,
                  "attributes": {
                    "content": "year: Dawn of the Seven"
                  },
                  "children": [],
                  "type": "text",
                  "annotations": [],
                  "slots": {}
                }
              ],
              "type": "inline",
              "annotations": [],
              "slots": {}
            }
          ],
          "type": "paragraph",
          "annotations": [],
          "slots": {}
        }
      ]
    }
  }'

Responses

The new event was successfully registered.

Bodyapplication/json

selfstring(uri)

URI of the event resource

publishedstring(date-time)

The date and time at which the event was published

titlestring

Unique name of the event

descriptionstring

Long form text detailing what the event is about, including performing acts, amenities and additional information important to potential attendees

statusstring

Current status of the event

typestring

Nature of the event. Determines what information is collected on ticket purchase.

publicboolean

Whether or not the event is open to the general public

categoryobject(response-5)

subcategorystring

Subcategory under which the event is classified

startstring(date-time)

The date and time at which the event is scheduled to begin

endstring(date-time)

The date and time at which the event is scheduled to finish

venueobject(response-6)

The location at which the event is taking place

disclaimerstring

Subcategory under which the event is classified

tagsArray of strings

List of short phrases that can be used to search and share the event

bannerstring(uri)

URI of the event's banner image

thumbnailstring(uri)

URI of the event's thumbnail image

popularityinteger

Score indicating how much activity the event is generating.

sectionsArray of objects(digest-3)

A list of the event's subdivisions, each of which offer a unique experience to ticket holders (E.g. General, VIP, Backstage, etc.)

Response

application/json

{
  "self": "/events/16993717817996",
  "published": "2024-05-03T17:30",
  "title": "Dawn of the Seven Premier",
  "description": "World Premier of the long anticipated movie event of the\nyear: Dawn of the Seven\n",
  "status": "Listed",
  "type": "Standard",
  "public": true,
  "category": {
    "self": "/categories/16878141745207",
    "name": "Cinema",
    "subcategories": [ … ]
  },
  "subcategory": "Premier",
  "start": "2024-06-07T20:00",
  "end": "2024-06-07T23:00",
  "venue": {
    "self": "/venues/16878146473429",
    "name": "Vought Tower",
    "region": "/regions/19290238432215",
    "longitude": -73.99214,
    "latitude": 40.75518,
    "address": "7th Ave, Manhattan, New York",
    "map": "https://maps.googleapis.com/maps/api/staticmap?center=40.75518,-73.99214&zoom=15&size=600x300&maptype=roadmap&markers=color:red%7C40.75518,-73.99214&key=AIzaSyCyLy8bOLUTLbQLVQFwf1eVO2UIVO8_4kQ&signature=IowClV__Bha7DFVe7TIG-osgyDE="
  },
  "disclaimer": "",
  "tags": [
    "homelander",
    "queen maeve",
    "the deep",
    "A-Train"
  ],
  "banner": "http://localhost/media/16993717817996-banner.jpeg",
  "thumbnail": "http://localhost/media/16993717817996-thumbnail.jpeg",
  "popularity": 40,
  "sections": [
    { … }
  ],
  "x-parsed-md-description": {
    "result": [ … ]
  }
}

Event Admissions

Operations

Event Reporting

Operations

Ad Zone Management

Operations

Advertising an Event

Operations

Placing an Order

Operations

Order Settlement

Operations

Ticket Transfers

Operations

Region Management

Operations

Venue Management

Operations

Category Management

Operations

Reviewing Content

Operations

Transaction Reports

Operations

Default Values

Operations

TickeTing REST API v3 Reference (3.0.0)

Introduction

Authentication

Example Request Header

Authentication Errors

Client Version

Example Request Header

Client Version Errors

Error Responses

404 Errors

Server Errors

Other Errors

Session Authentication

Token Authentication

API Integrations

Account Management

Account Verification

Account Activation

Password Reset

Account Activity

Managing Host Accounts

Working with Events

List all published events

Request

Responses

Was this helpful?

List all events

Request

Responses

Was this helpful?

Register an event

Request

Responses

Was this helpful?

Event Admissions

Event Reporting

Ad Zone Management

Advertising an Event

Placing an Order

Order Settlement

Ticket Transfers

Region Management

Venue Management

Category Management

Reviewing Content

Transaction Reports

Default Values