Get Venues Endpoint
This endpoint will allow resellers to retrieve venue 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/venues/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 |
---|---|
id | The resellers ID for the venue. Type: String |
name | The name of the venue. Type: String |
address_line_one | The first line of the address for the venue. Type: String |
city | The city of the venue. Type: String |
country_code | ISO-3166-2 Format. Please refer to supported country codes Type: String |
mapped_status | True/False Will return venues based on whether the reseller has already mapped to a Tixstock venue. Type: Boolean |
sort_order | asc / desc Type: String |
order_by | Accepted Values: * id * name |
per_page | Max: 50 Type: Integer |
page | Type: Integer |
API Response:
{
"data": [
{
"id": "3",
"name": "Anfield",
"address_line_1": "Anfield Rd,",
"address_line_2": "Anfield",
"city": "Liverpool",
"state": "",
"postcode": "L4 0TH",
"country_code": "GB",
"events": [
{
"id": "2",
"name": "Liverpool v Watford",
"currency": "GBP",
"commission_percentage_fee": "10.00",
"datetime": "2020-05-17T15:00:00+0000",
"status": "Active",
"use_tixstock_venue_details": "false",
"map_url": "https://upload.wikimedia.org/wikipedia/commons/8/81/AngelStadiumSchematic.svg",
"venue_details": [
{
"id": "",
"name": "Longside Upper Tier",
"sections": [
{
"id": "",
"name": "Longside Upper Tier"
}
]
}
],
"performers": [
{
"id": "1",
"name": "Liverpool FC"
},
{
"id": "18",
"name": "Watford FC"
}
]
}
],
}
],
"meta": {
"mode": "Production",
"type": "venues.get",
"current_page": 1,
"from": 1,
"path": "https://api.tixstock.com/v1/venues/get",
"per_page": 10,
"to": 1,
"request_id": "01eg13cw13473tagfvrxscpmbd"
},
"links": {
"self": "link-value",
"first": "https://api.tixstock.com/v1/venues/get?page=1",
"last": null,
"prev": null,
"next": null
}
}