List holds

GET 
https://api.tickettailor.com/v1/holds

Returns a paginated list of holds

Request

Query Parameters

limit string

The number of items to retrieve

event_id string

A string representing the event ID

created_at integer

Unix timestamp filter that returns items with matched created_at value.

created_at.gt integer

Unix timestamp filter that returns items with created_at greater than given value.

created_at.gte integer

Unix timestamp filter that returns items with created_at greater than or equal given value.

created_at.lt integer

Unix timestamp filter that returns items with created_at less than given value.

created_at.lte integer

Unix timestamp filter that returns items with created_at less than or equal given value.

updated_at integer

Unix timestamp filter that returns items with matched updated_at value.

updated_at.gt integer

Unix timestamp filter that returns items with updated_at greater than the given value.

updated_at.gte integer

Unix timestamp filter that returns items with updated_at greater than or equal to the given value.

updated_at.lt integer

Unix timestamp filter that returns items with updated_at less than given value.

updated_at.lte integer

Unix timestamp filter that returns items with updated_at less than or equal given value.

Responses

200

A successfully returned list of holds

application/json

Schema

Schema

data object[]
Array [
objectstring
idstring
A unque identifier for the hold
created_at
datestring
ISO-8601 date for the created timestamp of the hold
formattedstring
A formatted date string for the created timestamp of the hold
isostring
ISO-8601 date and time for the created timestamp of the hold
timestring
Time of the created timestamp of the hold
timezonestring
Timezone offset for the created timestamp of the hold
unixinteger
Unix timestamp for when the hold was created
event_idstring
ID of the event that the hold belongs to
notestring
A note for the hold
total_on_holdinteger
Total number of tickets on hold
updated_at
datestring
ISO-8601 date for the updated timestamp of the hold
formattedstring
A formatted date string for the updated timestamp of the hold
isostring
ISO-8601 date and time for the updated timestamp of the hold
timestring
Time of the updated timestamp of the hold
timezonestring
Timezone offset for the updated timestamp of the hold
unixinteger
Unix timestamp for when the hold was updated
quantities object[]
Hold quantities for each of the associated ticket type ID
Array [
ticket_type_idstring
Ticket type ID
quantityinteger
Number of held tickets of this type
]
]
links object
nextstringnullable
previousstringnullable

Example (auto)

{
  "data": [
    {
      "object": "hold",
      "id": "ho_1",
      "created_at": {
        "date": "2020-05-01",
        "formatted": "Fri 1 May 2020 10:30 PM",
        "iso": "2020-05-01T22:30:00+01:00",
        "time": "22:30",
        "timezone": "+01:00",
        "unix": 1588368600
      },
      "note": "This is the note about the hold",
      "total_on_hold": 6,
      "update_at": {
        "date": "2020-05-01",
        "formatted": "Fri 1 May 2020 10:30 PM",
        "iso": "2020-05-01T22:30:00+01:00",
        "time": "22:30",
        "timezone": "+01:00",
        "unix": 1588368600
      },
      "quantities": [
        {
          "ticket_type_id": "tt_1",
          "quantity": 1
        },
        {
          "ticket_type_id": "tt_2",
          "quantity": 5
        }
      ]
    }
  ],
  "links": {
    "next": "/v1/holds?starting_after=ho_120",
    "previous": "/v1/holds?ending_before=ho_100"
  }
}

default

Error schema

application/json

Schema

Schema

statusintegerrequired
Http status code
error_codestringrequired
Readable error code
messagestringrequired
Detailed error message
errors object[]
Validation errors if POST request was sent. Otherwise not present.
Array [
fieldstring
Field name that failed validation
messagesstring[]
Validation error message
]

Example (auto)

{
  "status": 0,
  "error_code": "string",
  "message": "string",
  "errors": [
    {
      "field": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Authorization: http

name: BasicAuthtype: httpdescription: Use base64 encoded api key created in Ticket Tailor dashboard.
scheme: basic

• curl
• php
• ruby
• python
• nodejs
• go

• CURL

curl -L 'https://api.tickettailor.com/v1/holds' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Request Collapse all

Base URL

https://api.tickettailor.com

Auth

Username

Password

Parameters

limit — query

event_id — query

created_at — query

created_at.gt — query

created_at.gte — query

created_at.lt — query

created_at.lte — query

updated_at — query

updated_at.gt — query

updated_at.gte — query

updated_at.lt — query

updated_at.lte — query