{"_id":"564b8422cc472d0d00da9453","version":{"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","__v":17,"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"},"category":{"_id":"55773acb07e7110d001043ee","pages":["55776c5f07e7110d00104499","564b840485e4e92b00fb4f9d","564b8422cc472d0d00da9453","564b8436cc472d0d00da9455","564b84471ed5c823003eb662","564b84591ed5c823003eb664","564b8468766d4923004e1fcd","564b84944f06ef2b006b08b2","564b84a0766d4923004e1fcf"],"__v":9,"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:15.370Z","from_sync":false,"order":7,"slug":"federation-api","title":"Federation API"},"project":"55773a5ba042551900b002cb","__v":3,"editedParams2":true,"parentDoc":null,"editedParams":true,"user":"546d17e2eb9cfd1400dd4529","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T19:46:42.739Z","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\":164,\n   \"per_page\":\"2\",\n   \"current_page\":1,\n   \"last_page\":82,\n   \"next_page_url\":\"https://api.triathlon.org/v1/federations?per_page=2&name=®ion_id=&country_id=&federation_id=&status=&page=2\",\n   \"prev_page_url\":null,\n   \"from\":1,\n   \"to\":2,\n   \"data\":[\n      {\n         \"federation_id\":2390,\n         \"federation_title\":\"Antigua and Barbuda Triathlon Association\",\n         \"federation_slug\":\"antigua_and_barbuda_triathlon_association\",\n         \"federation_edit_date\":\"2015-04-15T08:57:35+00:00\",\n         \"federation_country_id\":107,\n         \"federation_region_id\":11,\n         \"federation_region_name\":\"Americas\",\n         \"federation_affiliation_status\":\"Affiliated\",\n         \"federation_noc\":\"ANT\",\n         \"federation_country_name\":\"Antigua and Barbuda\",\n         \"federation_country_isoa2\":\"AG\",\n         \"federation_flag\":\"https://f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com/images/icons/ag.png\",\n         \"federation_listing\":\"http://americas.triathlon.org/federations/federation/antigua_and_barbuda_triathlon_association\",\n         \"federation_api_listing\":\"https://api.triathlon.org/v1/v1/federations/2390\"\n      },\n      {\n         \"federation_id\":70417,\n         \"federation_title\":\"Armenian Triathlon Federation\",\n         \"federation_slug\":\"armenian_triathlon_federation\",\n         \"federation_edit_date\":\"2015-04-28T12:06:28+00:00\",\n         \"federation_country_id\":109,\n         \"federation_region_id\":10,\n         \"federation_region_name\":\"Europe\",\n         \"federation_affiliation_status\":\"Affiliated\",\n         \"federation_noc\":\"ARM\",\n         \"federation_country_name\":\"Armenia\",\n         \"federation_country_isoa2\":\"AM\",\n         \"federation_flag\":\"https://f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com/images/icons/am.png\",\n         \"federation_listing\":\"http://europe.triathlon.org/federations/federation/armenian_triathlon_federation\",\n         \"federation_api_listing\":\"https://api.triathlon.org/v1/v1/federations/70417\"\n      }\n   ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5658cfda5a9e990d004a5cdd","ref":"","in":"query","required":false,"desc":"How many Federations to be returned per page","default":"10","type":"int","name":"per_page"},{"_id":"5658cfda5a9e990d004a5cdc","ref":"","in":"query","required":false,"desc":"The page number to be returned","default":"","type":"int","name":"page"},{"_id":"5658cfda5a9e990d004a5cdb","ref":"","in":"query","required":false,"desc":"A pipe delimited list of country ids","default":"","type":"string","name":"country_id"},{"_id":"5658cfda5a9e990d004a5cda","ref":"","in":"query","required":false,"desc":"A pipe delimited list of region ids","default":"","type":"string","name":"region_id"},{"_id":"5658cfda5a9e990d004a5cd9","ref":"","in":"query","required":false,"desc":"Restrict returned Federations by name","default":"","type":"string","name":"name"},{"_id":"56b504b485a6922300d1c4f3","ref":"","in":"query","required":false,"desc":"A pipe delimited list of Federation ids","default":"","type":"string","name":"federation_id"},{"_id":"56ccc6b38fa8b01b00b81fae","ref":"","in":"query","required":false,"desc":"The affiliation status of the Federation","default":"","type":"string","name":"status"}],"url":"/federations"},"isReference":true,"order":1,"body":"The **Federation Listings** method returns a paginated, filterable list of basic federation objects matching the search criteria.\n\nThe `name` parameter allows a fuzzy search on the Federation name.\n\nFor the `country_id` and `region_id` parameters please consult the [Country Listings](https://developers.triathlon.org/docs/country-listings) and [Region Listings](https://developers.triathlon.org/docs/region-listings) endpoints. Both values take a pipe delimited list of values.\n\nThe `status` paremeter filters Federation by their affiliation status and must be one of either `affiliated`, `nonaffiliated` or `provisional`.\n\nThe following example retrieves all Federations from Oceania:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/federations?region_id=14\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"federation-listings","type":"endpoint","title":"Federation Listings"}

getFederation Listings


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer10
How many Federations to be returned per page
page:
integer
The page number to be returned
country_id:
string
A pipe delimited list of country ids
region_id:
string
A pipe delimited list of region ids
name:
string
Restrict returned Federations by name
federation_id:
string
A pipe delimited list of Federation ids
status:
string
The affiliation status of the Federation

Result Format


Documentation

The **Federation Listings** method returns a paginated, filterable list of basic federation objects matching the search criteria. The `name` parameter allows a fuzzy search on the Federation name. For the `country_id` and `region_id` parameters please consult the [Country Listings](https://developers.triathlon.org/docs/country-listings) and [Region Listings](https://developers.triathlon.org/docs/region-listings) endpoints. Both values take a pipe delimited list of values. The `status` paremeter filters Federation by their affiliation status and must be one of either `affiliated`, `nonaffiliated` or `provisional`. The following example retrieves all Federations from Oceania: [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/federations?region_id=14", "language": "curl" } ] } [/block]

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 }}