7b222e8ec91c
List holds
Returns a paginated list of holds
Query parameters
The number of items to retrieve
A string representing the event ID
Unix timestamp filter that returns items with matched created_at value.
Unix timestamp filter that returns items with created_at greater than given value.
Unix timestamp filter that returns items with created_at greater than or equal given value.
Unix timestamp filter that returns items with created_at less than given value.
Unix timestamp filter that returns items with created_at less than or equal given value.
Unix timestamp filter that returns items with matched updated_at value.
Unix timestamp filter that returns items with updated_at greater than the given value.
Unix timestamp filter that returns items with updated_at greater than or equal to the given value.
Unix timestamp filter that returns items with updated_at less than given value.
Unix timestamp filter that returns items with updated_at less than or equal given value.
Response
A successfully returned list of holds
Example response
{
"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"
}
}