Get Events Endpoint
This endpoint will allow resellers to retrieve event information from within the Tixstock system.
The endpoint will also return whether the event is already mapped with the resellers event.
Endpoint URL
https://api.tixstock.com/v1/events/get
Authorisation
Authorisation | Description |
---|---|
Bearer Token | A valid bearer token must be provided within the header parameters for the API request. To generate an access token, please see your API settings from within the Tixstock Reseller Admin Area. |
Please see 'Authentication - Bearer Tokens' for further information
Request Data
The supplied data must adhere to the following ruleset and passed as query parameters:
Query Parameters | Description |
---|---|
event_id | The resellers ID for the event. Type: String |
event_name | The name of the event. Type: String |
venue_name | The name of the event venue. Type: String |
performer_name | The name of the performer. Type: String |
category_name | The category the event is assigned to. Type: String Example: Football |
tags | Array of tags assigned to an event. Please note: Tixstock administrates Event Tags as a alternative way to filter events Type: Array Example: EPL |
mapped_status | True/False Will return events based on whether the reseller already has event mapped to the Tixstock event. Type: Boolean |
start_date | A valid ISO-8601 DateTime format. |
end_date | A valid ISO-8601 DateTime format. |
sort_order | asc / desc Type: String |
order_by | Accepted Values: * event_id * event_date * venue_name * performer_name |
per_page | Max: 50 Type: Integer |
page | Type: Integer |
API Response:
Please note that depending on whether the event has been mapped to an existing Tixstock event, the data returned will either be Tixstock’s event data or the resellers event data.
A ‘mapped_status’ will be returned in the response for reference of whether the event has been mapped or not.
{
"data": [
{
"id": "94159864",
"name": "Norwich City FC vs Burnley FC Tickets",
"currency": "EUR",
"commission_percentage_fee": "10.00",
"datetime": "2020-05-09T14:00:00+0000",
"status": "Active",
"map_url": "https://upload.wikimedia.org/wikipedia/commons/8/81/AngelStadiumSchematic.svg",
"venue": {
"id": "7845665",
"name": "Carrow Road",
"address_line_one": "",
"address_line_two": "",
"city": "Norwich",
"state": "NFK",
"postcode": "NR1 1JE",
"country_code": "GB"
},
"use_tixstock_venue_details": "false",
"venue_details": [
{
"id": "1234121",
"name": "Away Fan Section",
"sections": [
{
"id": "241231",
"name": "Away Fan Section 21"
},
{
"id": "241121",
"name": "Away Fan Section 22"
},
{
"id": "241011",
"name": "Away Fan Section 23"
}
]
}
],
"performers": [
{
"id": "5642621",
"name": "Norwich City FC"
},
{
"id": "5642912",
"name": "Burnley FC"
}
],
"category": {
"name": "Football",
"upcoming_events": 908,
"parent": {
"name": "Sport",
"parent": []
}
}
}
],
"meta": {
"mode": "Production",
"type": "event.get",
"current_page": 1,
"from": 1,
"path": "https://api.tixstock.com/v1/events/get",
"per_page": 10,
"to": 1,
"request_id": "01eg13cw13473tagfvrxscpmbd"
},
"links": {
"self": "link-value",
"first": "https://api.tixstock.com/v1/events/get?page=1",
"last": null,
"prev": null,
"next": null
}
}