{"__v":2,"_id":"564b7a4e1ed5c823003eb64b","category":{"__v":31,"_id":"55773ac207e7110d001043ed","pages":["55776bbce6063e0d00481401","564b7a4e1ed5c823003eb64b","564b7c0fdda79a19000f2653","564b7c2385e4e92b00fb4f8a","564b7c2edda79a19000f2656","564b7c394f06ef2b006b08a5","564b7c6b85e4e92b00fb4f8c","564b7c791ed5c823003eb64f","564b7c83cc472d0d00da943d","564b7c8f766d4923004e1fbc","564b7ca385e4e92b00fb4f8f","564b7cb21ed5c823003eb654","564b7ccb766d4923004e1fbf","564b7cdf766d4923004e1fc1","564b7ceecc472d0d00da9440","564b7d014f06ef2b006b08a8","564b7d201ed5c823003eb656","564b7d2ee323d01700a51340","564b7d3b1ed5c823003eb658","564b7d4be323d01700a51344","564b7d5ee323d01700a51346","564b7d73cc472d0d00da9442","564b7d8adda79a19000f265a","564b7e0b85e4e92b00fb4f92","564b7e1be323d01700a51348","564b7e2b1ed5c823003eb65a","564b7e3f766d4923004e1fc4","564b7e4fdda79a19000f265c","564b7e5a766d4923004e1fc6","56eb12a90e62750e0060d027","56f184bf3af4942b00bb3c33"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:06.237Z","from_sync":false,"order":3,"slug":"events-api","title":"Events API"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"55773a5ba042551900b002cb","user":"546d17e2eb9cfd1400dd4529","version":{"__v":17,"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","createdAt":"2015-06-09T19:11:23.764Z","releaseDate":"2015-06-09T19:11:23.764Z","categories":["55773a5ca042551900b002cf","55773a6ce6063e0d00481380","55773ab007e7110d001043ec","55773abaa042551900b002d5","55773ac207e7110d001043ed","55773acb07e7110d001043ee","55773ad3a042551900b002d6","55773adce6063e0d00481383","55773ae4a042551900b002d7","55773af307e7110d001043ef","55773af907e7110d001043f0","55773b0407e7110d001043f1","563a4f7ad25e8919005f3f39","563a4fcaa19edf0d00972321","564a70dc4cd0521700523edf","564b797bcc472d0d00da9435","564b855b766d4923004e1fd1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T19:04:46.831Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"total\":1,\n   \"per_page\":10,\n   \"current_page\":1,\n   \"last_page\":1,\n   \"next_page_url\":null,\n   \"prev_page_url\":null,\n   \"from\":1,\n   \"to\":1,\n   \"data\":[\n      {\n         \"event_id\":5105,\n         \"event_title\":\"2009 Dextro Energy Triathlon - ITU World Championship Grand Final Gold Coast\",\n         \"event_slug\":\"2009_dextro_energy_triathlon_-_itu_world_championship_grand_final_gold_coas\",\n         \"event_edit_date\":\"2013-01-29T02:26:42+00:00\",\n         \"event_venue\":\"Gold Coast\",\n         \"event_country\":\"Australia\",\n         \"event_latitude\":-28.136289,\n         \"event_longitude\":153.477806,\n         \"event_date\":\"2009-09-09\",\n         \"event_finish_date\":\"2009-09-13\",\n         \"event_country_isoa2\":\"AU\",\n         \"event_country_noc\":\"AUS\",\n         \"event_region_id\":14,\n         \"event_country_id\":111,\n         \"event_region_name\":\"Oceania\",\n         \"event_categories\":[\n            {\n               \"cat_name\":\"World Championships\",\n               \"cat_id\":348,\n               \"cat_parent_id\":0\n            },\n            {\n               \"cat_name\":\"World Triathlon Series\",\n               \"cat_id\":351,\n               \"cat_parent_id\":0\n            }\n         ],\n         \"event_specifications\":[\n            {\n               \"cat_name\":\"Triathlon\",\n               \"cat_id\":357,\n               \"cat_parent_id\":0\n            },\n            {\n               \"cat_name\":\"Sprint\",\n               \"cat_id\":376,\n               \"cat_parent_id\":357\n            },\n            {\n               \"cat_name\":\"Standard\",\n               \"cat_id\":377,\n               \"cat_parent_id\":357\n            },\n            {\n               \"cat_name\":\"Paratriathlon\",\n               \"cat_id\":381,\n               \"cat_parent_id\":357\n            }\n         ],\n         \"event_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/au.png\",\n         \"event_listing\":\"http:\\/\\/www.triathlon.org\\/events\\/event\\/2009_dextro_energy_triathlon_-_itu_world_championship_grand_final_gold_coas\",\n         \"event_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/events\\/5105\"\n      }\n   ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5658a5de1d3c450d0019dbea","ref":"","in":"query","required":false,"desc":"How many events to be returned per page","default":"10","type":"int","name":"per_page"},{"_id":"5658a5de1d3c450d0019dbe9","ref":"","in":"query","required":false,"desc":"The page number to be returned","default":"","type":"int","name":"page"},{"_id":"5658a5de1d3c450d0019dbe8","ref":"","in":"query","required":false,"desc":"A pipe delimited list of category ids","default":"","type":"string","name":"category_id"},{"_id":"5658a5de1d3c450d0019dbe7","ref":"","in":"query","required":false,"desc":"A pipe delimited list of specification ids","default":"","type":"string","name":"specification_id"},{"_id":"5658a5de1d3c450d0019dbe6","ref":"","in":"query","required":false,"desc":"Restrict returned events by name","default":"","type":"string","name":"name"},{"_id":"5658a5de1d3c450d0019dbe5","ref":"","in":"query","required":false,"desc":"The earliest date for events to be returned","default":"","type":"yyyy-mm-dd","name":"start_date"},{"_id":"5658a5de1d3c450d0019dbe4","ref":"","in":"query","required":false,"desc":"The latest date for events to be returned","default":"","type":"yyyy-mm-dd","name":"end_date"},{"_id":"5658a5de1d3c450d0019dbe3","ref":"","in":"query","required":false,"desc":"A pipe delimited list of region ids","default":"","type":"string","name":"region_id"},{"_id":"5658a5de1d3c450d0019dbe2","ref":"","in":"query","required":false,"desc":"A pipe delimited list of country ids","default":"","type":"string","name":"country_id"},{"_id":"5658a5de1d3c450d0019dbe1","ref":"","in":"query","required":false,"desc":"A pipe delimited list of event ids","default":"","type":"string","name":"event_id"},{"_id":"56b4e2293d5f130d00dad169","ref":"","in":"query","required":false,"desc":"Specify asc or desc ordering","default":"asc","type":"string","name":"order"}],"url":"/events"},"isReference":true,"order":1,"body":"The **Event Listings** method returns a paginated, filterable list of **basic event objects** matching the search criteria.\n\nThe following example list all 2015 World Triathlon Series events.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/events?category_id=351&start_date=2015-01-01&end_date=2016-01-01\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe `category_id`(https://developers.triathlon.org/docs/event-specifications) and `specification_id`(https://developers.triathlon.org/docs/event-specifications) parameters may be sourced from the respective API methods. \n\nThe `name`parameter performs a search that matches any part of the event name. Whilst the search is *fuzzy*, typos are not considered and only direct matches are returned. For a better search experience, more suitable for user-defined input, it is recommended to use the [Search API](doc:search-api-overview). \n\nThe `start_date` and `end_date` both expressed in yyyy-mm-dd format limit results by date. Only one parameter may be specified e.g. to find all events in the future simply the `start_date` param would be set.\n\nThe `region_id` parameter uses values from the [Federation Region Listings](https://developers.triathlon.org/docs/region-listings) method.\n\nFor many parameters you may supply a pipe delimited list of values to return multiple events, category_ids or specification_ids. For example another way to return all 2015 World Triathlon Series events by explicitly listing their `event_id`'s would be:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/events?event_id=91028|90161|90162|90163|90164|91029|90165|90166|90167|90168\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nYou may order the dates in either ascending or descending order by specifying the `order` parameter as either `asc` or `desc`.","excerpt":"","slug":"event-listings","type":"endpoint","title":"Event Listings"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer10
How many events to be returned per page
page:
integer
The page number to be returned
category_id:
string
A pipe delimited list of category ids
specification_id:
string
A pipe delimited list of specification ids
name:
string
Restrict returned events by name
start_date:
yyyy-mm-dd
The earliest date for events to be returned
end_date:
yyyy-mm-dd
The latest date for events to be returned
region_id:
string
A pipe delimited list of region ids
country_id:
string
A pipe delimited list of country ids
event_id:
string
A pipe delimited list of event ids
order:
stringasc
Specify asc or desc ordering

Result Format


Documentation

The **Event Listings** method returns a paginated, filterable list of **basic event objects** matching the search criteria. The following example list all 2015 World Triathlon Series events. [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/events?category_id=351&start_date=2015-01-01&end_date=2016-01-01", "language": "curl" } ] } [/block] The `category_id`(https://developers.triathlon.org/docs/event-specifications) and `specification_id`(https://developers.triathlon.org/docs/event-specifications) parameters may be sourced from the respective API methods. The `name`parameter performs a search that matches any part of the event name. Whilst the search is *fuzzy*, typos are not considered and only direct matches are returned. For a better search experience, more suitable for user-defined input, it is recommended to use the [Search API](doc:search-api-overview). The `start_date` and `end_date` both expressed in yyyy-mm-dd format limit results by date. Only one parameter may be specified e.g. to find all events in the future simply the `start_date` param would be set. The `region_id` parameter uses values from the [Federation Region Listings](https://developers.triathlon.org/docs/region-listings) method. For many parameters you may supply a pipe delimited list of values to return multiple events, category_ids or specification_ids. For example another way to return all 2015 World Triathlon Series events by explicitly listing their `event_id`'s would be: [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/events?event_id=91028|90161|90162|90163|90164|91029|90165|90166|90167|90168", "language": "curl" } ] } [/block] You may order the dates in either ascending or descending order by specifying the `order` parameter as either `asc` or `desc`.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}