Skip to content

List event hosts

Request

Retrieve a list of registered event hosts that match the given criteria.

Security
SessionKey(Required scopes: publiccustomeradministrator)
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
namestring

If set, only returns hosts whose name matches the specified regular expression

countrystring

If set, only returns hosts based in the specified country

sortstring

If set, determines how the returned hosts list is sorted

Value:"alphabetical"
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/hosts?records=25&page=1&name=string&country=string&sort=alphabetical&order=asc' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The list of matching event hosts 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-5)
Response
{
  "page": 1,
  "records": 5,
  "entries": [
    { … }
  ]
}