Providers
This endpoint provides a list of providers. At present, data is specific to COVID-19 test providers
Provider Request and Response Structure
https://requirements-api.sandbox.joinsherpa.com/v2/providers?filter[countries]=CAN&
filter[category]=TEST&filter[subCategory]=COVID_TEST&key={{apiKey}}&language=en-US
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.4"
},
"data": [
{
"id": "857e811b-d4cb-41b1-97e3-2a6dd78e161a",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Test Sherpa",
"title": "Book your test with Test Sherpa",
"url": "https://apply.joinsherpa.com",
"type": "LINK"
}
],
"name": "Test Sherpa",
"taglines": [
"this is a tagline!"
],
"discountCodes": [
"This is a discount code: SHERPA22"
],
"logos": [],
"locations": [
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "United States",
"type": "COUNTRY"
},
{
"code": "GBR",
"name": "United Kingdom",
"type": "COUNTRY"
}
],
"tags": [
"RAPID_TEST",
"ANTIGEN_TEST",
"MOLECULAR_TEST",
"PCR_TEST"
]
}
},
{
"id": "ad9aa728-3f0b-4f6b-92c2-959a1cf47b42",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Cue Health",
"title": "Book your test with Cue Health",
"url": "https://shop.cuehealth.ca/?utm_source=sherpa&utm_campaign=CA_CUE_ENT-Partner_CDN_Sherpa_2022",
"type": "LINK"
}
],
"name": "Cue Health",
"taglines": [
"Buy on-the-go, lab-quality tests from Cue"
],
"discountCodes": [
"Save BIG with code CUE+SHERPA10"
],
"logos": [],
"locations": [
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
}
],
"tags": []
}
},
{
"id": "de3ab987-c631-459c-8eef-3d9a74acfe58",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Test for Travel",
"title": "Book your test with Test for Travel",
"url": "https://testfortravel.com/covid-19-testing-locations/?utm_source=sherpa",
"type": "LINK"
}
],
"name": "Test for Travel",
"taglines": [
"Find COVID-19 testing near you"
],
"logos": [],
"locations": [
{
"code": "ABW",
"name": "Aruba",
"type": "COUNTRY"
},
{
"code": "BRB",
"name": "Barbados",
"type": "COUNTRY"
},
{
"code": "BES",
"name": "Bonaire, Sint Eustatius and Saba",
"type": "COUNTRY"
},
{
"code": "BHS",
"name": "Bahamas",
"type": "COUNTRY"
},
{
"code": "BLZ",
"name": "Belize",
"type": "COUNTRY"
},
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "CRI",
"name": "Costa Rica",
"type": "COUNTRY"
},
{
"code": "CUB",
"name": "Cuba",
"type": "COUNTRY"
},
{
"code": "CUW",
"name": "Curaçao",
"type": "COUNTRY"
},
{
"code": "DOM",
"name": "Dominican Republic",
"type": "COUNTRY"
},
{
"code": "GRD",
"name": "Grenada",
"type": "COUNTRY"
},
{
"code": "GTM",
"name": "Guatemala",
"type": "COUNTRY"
},
{
"code": "HND",
"name": "Honduras",
"type": "COUNTRY"
},
{
"code": "JAM",
"name": "Jamaica",
"type": "COUNTRY"
},
{
"code": "MEX",
"name": "Mexico",
"type": "COUNTRY"
},
{
"code": "PAN",
"name": "Panama",
"type": "COUNTRY"
},
{
"code": "PRI",
"name": "Puerto Rico",
"type": "COUNTRY"
},
{
"code": "SLV",
"name": "El Salvador",
"type": "COUNTRY"
},
{
"code": "SXM",
"name": "Sint Maarten",
"type": "COUNTRY"
},
{
"code": "TCA",
"name": "Turks and Caicos Islands",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "United States",
"type": "COUNTRY"
}
],
"tags": []
}
}
]
}
Category and Subcategory
The current category of Test and subcategory of COVID_TEST are only supported. Sherpa° will look in the future to expand these further.
Providers Model
| Attribute | Type | Description |
|---|---|---|
| id | string | Unique identifier for the provider |
| type | string | Will have the value of "Provider " always for this endpoint at present, denotes the type of data to be presented. |
| category | object | Provides a value and label. Value - "Test" Label - Translation of Test in a language passed in filters. In the present iteration the value will always be "Test" , label will provide a translation of "test" if one is available. Please see how list of supported languages here |
| subcategory | object | provides a value and label. Value - "COVID_TEST" Label - Translation of Covid_Test in a language passed in filters. In the present iteration the value will always be "COVID_TEST" , label will provide a translation of "covid_test" if one is available. Please see how list of supported languages here |
| actions | array | Provides details of test providers provider - Name of the provider title - associated or provided title by provider url - link to provider website type - mentions the url is a link. Will have a value of "Link" |
| name | string | Name of the provider |
| taglines | array | provider specific taglines |
| logos | array | will have any provider specific logo |
| locations | array | Will contact detail of countries provider has location in code - ISO alpha-3 code of a country. name - Country Name type - describes if it is a country, region or airport |
| discountCodes | array | Any provided discount codes applicable to the provider |
| tags | array | This is a placeholder for the future to help tag different types of tests. Not in use at present. |
Available Filters
| Filter Name | Data filtered |
|---|---|
| filter [countries] | Provider data can be filtered based on countries. WIll take ISO-3 value of a country (eg: GBR, CAN) |
| filter[regions] | Provider data can be filtered based on regions. (e.g., US-TX) |
| filter [airport] | Provider data can be filtered based on 3 digit airport code (e.g: YYZ). |
| language | Provides response data in the selected language . Please see how the list of supported languages here |
| filter[category] | The only applicable value at present is "Test" at present. |
| filter [subCategory] | The only applicable value at present is "COVID_TEST" at present. |
Examples
Below is not an exhaustive list but some example responses
1. A list of all COVID-19 providers for Great Britain (GBR)
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.4"
},
"data": [
{
"id": "0a56b0bf-c2d6-44af-8105-506d0c47ce61",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Test for Travel",
"title": "Book your test with Test for Travel",
"url": "https://testfortravel.com/covid-19-testing-locations/?utm_source=sherpa",
"type": "LINK"
}
],
"name": "Test for Travel",
"taglines": [
"Find COVID-19 testing near you"
],
"logos": [],
"locations": [
{
"code": "AND",
"name": "Andorra",
"type": "COUNTRY"
},
{
"code": "AUT",
"name": "Austria",
"type": "COUNTRY"
},
{
"code": "BIH",
"name": "Bosnia and Herzegovina",
"type": "COUNTRY"
},
{
"code": "BEL",
"name": "Belgium",
"type": "COUNTRY"
},
{
"code": "BGR",
"name": "Bulgaria",
"type": "COUNTRY"
},
{
"code": "CHE",
"name": "Switzerland",
"type": "COUNTRY"
},
{
"code": "CYP",
"name": "Cyprus",
"type": "COUNTRY"
},
{
"code": "CZE",
"name": "Czech Republic",
"type": "COUNTRY"
},
{
"code": "DEU",
"name": "Germany",
"type": "COUNTRY"
},
{
"code": "DNK",
"name": "Denmark",
"type": "COUNTRY"
},
{
"code": "EST",
"name": "Estonia",
"type": "COUNTRY"
},
{
"code": "ESP",
"name": "Spain",
"type": "COUNTRY"
},
{
"code": "FIN",
"name": "Finland",
"type": "COUNTRY"
},
{
"code": "FRA",
"name": "France",
"type": "COUNTRY"
},
{
"code": "GBR",
"name": "United Kingdom",
"type": "COUNTRY"
},
{
"code": "GIB",
"name": "Gibraltar",
"type": "COUNTRY"
},
{
"code": "GRC",
"name": "Greece",
"type": "COUNTRY"
},
{
"code": "HRV",
"name": "Croatia",
"type": "COUNTRY"
},
{
"code": "HUN",
"name": "Hungary",
"type": "COUNTRY"
},
{
"code": "IRL",
"name": "Ireland",
"type": "COUNTRY"
},
{
"code": "IMN",
"name": "Isle of Man",
"type": "COUNTRY"
}
],
"tags": []
}
},
{
"id": "857e811b-d4cb-41b1-97e3-2a6dd78e161a",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Test Sherpa",
"title": "Book your test with Test Sherpa",
"url": "https://apply.joinsherpa.com",
"type": "LINK"
}
],
"name": "Test Sherpa",
"taglines": [
"this is a tagline!"
],
"discountCodes": [
"This is a discount code: SHERPA22"
],
"logos": [],
"locations": [
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "United States",
"type": "COUNTRY"
},
{
"code": "GBR",
"name": "United Kingdom",
"type": "COUNTRY"
}
],
"tags": [
"RAPID_TEST",
"ANTIGEN_TEST",
"MOLECULAR_TEST",
"PCR_TEST"
]
}
},
{
"id": "b52a4eb6-74ce-47f2-97c5-ea6e4e0f46d1",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Collinson",
"title": "Book your test with Collinson",
"url": "https://www.collinsongroup.com/en/covid-19-testing?utm_source=Sherpa+UK&utm_medium=Referral&utm_campaign=Sherpa+UK",
"type": "LINK"
}
],
"name": "Collinson",
"discountCodes": [
"Use SHERPA20OFF for 20% off UK tests"
],
"logos": [
{
"url": "https://cdn.joinsherpa.io/providers/logos/collinson-logo-rgb.svg",
"format": "SVG"
}
],
"locations": [
{
"code": "GBR",
"name": "United Kingdom",
"type": "COUNTRY"
}
],
"tags": []
}
}
]
}
2. Displaying all COVID-19 providers by region (Texas)
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.4"
},
"data": [
{
"id": "a63f9659-4e95-4b65-af9c-4ca4ee000233",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Collinson",
"title": "Book your test with Collinson",
"url": "https://www.collinsongroup.com/en/covid-19-testing/dallas-fort-worth-airport?utm_source=Sherpa+DFW&utm_medium=Referral&utm_campaign=Sherpa+DFW",
"type": "LINK"
}
],
"name": "Collinson",
"taglines": [
"A global leader in travel testing"
],
"logos": [
{
"format": "SVG",
"url": "https://cdn.joinsherpa.io/providers/logos/collinson-logo-rgb.svg"
}
],
"locations": [
{
"code": "US-TX",
"name": "Texas",
"type": "REGION"
}
],
"tags": []
}
},
{
"id": "857e811b-d4cb-41b1-97e3-2a6dd78e161a",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Test Sherpa",
"title": "Book your test with Test Sherpa",
"url": "https://apply.joinsherpa.com",
"type": "LINK"
}
],
"name": "Test Sherpa",
"taglines": [
"this is a tagline!"
],
"discountCodes": [
"This is a discount code: SHERPA22"
],
"logos": [],
"locations": [
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "United States",
"type": "COUNTRY"
},
{
"code": "GBR",
"name": "United Kingdom",
"type": "COUNTRY"
}
],
"tags": [
"RAPID_TEST",
"ANTIGEN_TEST",
"MOLECULAR_TEST",
"PCR_TEST"
]
}
},
{
"id": "92d35747-60c8-4797-b8e8-1a61c8842e7e",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Cue Health",
"title": "Book your test with Cue Health",
"url": "https://shop.cuehealth.com/?utm_source=sherpa&utm_campaign=US_CUE_ENT-Partner_CDN_Sherpa_2022",
"type": "LINK"
}
],
"name": "Cue Health",
"taglines": [
"Buy on-the-go, lab-quality tests from Cue"
],
"discountCodes": [
"Save BIG with code CUE+SHERPA10"
],
"logos": [],
"locations": [
{
"code": "USA",
"name": "United States",
"type": "COUNTRY"
}
],
"tags": []
}
},
{
"id": "de3ab987-c631-459c-8eef-3d9a74acfe58",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Covid Test"
},
"actions": [
{
"provider": "Test for Travel",
"title": "Book your test with Test for Travel",
"url": "https://testfortravel.com/covid-19-testing-locations/?utm_source=sherpa",
"type": "LINK"
}
],
"name": "Test for Travel",
"taglines": [
"Find COVID-19 testing near you"
],
"logos": [],
"locations": [
{
"code": "ABW",
"name": "Aruba",
"type": "COUNTRY"
},
{
"code": "BRB",
"name": "Barbados",
"type": "COUNTRY"
},
{
"code": "BES",
"name": "Bonaire, Sint Eustatius and Saba",
"type": "COUNTRY"
},
{
"code": "BHS",
"name": "Bahamas",
"type": "COUNTRY"
},
{
"code": "BLZ",
"name": "Belize",
"type": "COUNTRY"
},
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "CRI",
"name": "Costa Rica",
"type": "COUNTRY"
},
{
"code": "CUB",
"name": "Cuba",
"type": "COUNTRY"
},
{
"code": "CUW",
"name": "Curaçao",
"type": "COUNTRY"
},
{
"code": "DOM",
"name": "Dominican Republic",
"type": "COUNTRY"
},
{
"code": "GRD",
"name": "Grenada",
"type": "COUNTRY"
},
{
"code": "GTM",
"name": "Guatemala",
"type": "COUNTRY"
},
{
"code": "HND",
"name": "Honduras",
"type": "COUNTRY"
},
{
"code": "JAM",
"name": "Jamaica",
"type": "COUNTRY"
},
{
"code": "MEX",
"name": "Mexico",
"type": "COUNTRY"
},
{
"code": "PAN",
"name": "Panama",
"type": "COUNTRY"
},
{
"code": "PRI",
"name": "Puerto Rico",
"type": "COUNTRY"
},
{
"code": "SLV",
"name": "El Salvador",
"type": "COUNTRY"
},
{
"code": "SXM",
"name": "Sint Maarten",
"type": "COUNTRY"
},
{
"code": "TCA",
"name": "Turks and Caicos Islands",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "United States",
"type": "COUNTRY"
}
],
"tags": []
}
}
]
}
3. Search for a test provider in Canada in the French language (fr-FR)
{
"meta": {
"copyright": "Sherpa",
"version": "2.8.4"
},
"data": [
{
"id": "857e811b-d4cb-41b1-97e3-2a6dd78e161a",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Test Covid"
},
"actions": [
{
"provider": "Test Sherpa",
"title": "Réservez votre test avec Test Sherpa",
"url": "https://apply.joinsherpa.com",
"type": "LINK"
}
],
"name": "Test Sherpa",
"taglines": [
"ceci est un slogan !"
],
"discountCodes": [
"Ceci est un code de réduction : SHERPA22"
],
"logos": [],
"locations": [
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "États-Unis",
"type": "COUNTRY"
},
{
"code": "GBR",
"name": "Royaume-Uni",
"type": "COUNTRY"
}
],
"tags": [
"RAPID_TEST",
"ANTIGEN_TEST",
"MOLECULAR_TEST",
"PCR_TEST"
]
}
},
{
"id": "ad9aa728-3f0b-4f6b-92c2-959a1cf47b42",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Test Covid"
},
"actions": [
{
"provider": "Cue Health",
"title": "Réservez votre test avec Cue Health",
"url": "https://shop.cuehealth.ca/?utm_source=sherpa&utm_campaign=CA_CUE_ENT-Partner_CDN_Sherpa_2022",
"type": "LINK"
}
],
"name": "Cue Health",
"taglines": [
"Achetez des tests de qualité laboratoire sur le pouce chez Cue"
],
"discountCodes": [
"Économisez GROS avec le code CUE+SHERPA10"
],
"logos": [],
"locations": [
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
}
],
"tags": []
}
},
{
"id": "de3ab987-c631-459c-8eef-3d9a74acfe58",
"type": "PROVIDER",
"attributes": {
"category": {
"value": "TEST",
"label": "Test"
},
"subCategory": {
"value": "COVID_TEST",
"label": "Test Covid"
},
"actions": [
{
"provider": "Test for Travel",
"title": "Réservez votre test avec Test for Travel",
"url": "https://testfortravel.com/covid-19-testing-locations/?utm_source=sherpa",
"type": "LINK"
}
],
"name": "Test for Travel",
"taglines": [
"Trouvez les centres dépistage COVID-19 près de chez vous"
],
"logos": [],
"locations": [
{
"code": "ABW",
"name": "Aruba",
"type": "COUNTRY"
},
{
"code": "BRB",
"name": "La Barbade",
"type": "COUNTRY"
},
{
"code": "BES",
"name": "Pays-Bas caribéens",
"type": "COUNTRY"
},
{
"code": "BHS",
"name": "Bahamas",
"type": "COUNTRY"
},
{
"code": "BLZ",
"name": "Belize",
"type": "COUNTRY"
},
{
"code": "CAN",
"name": "Canada",
"type": "COUNTRY"
},
{
"code": "CRI",
"name": "Costa Rica",
"type": "COUNTRY"
},
{
"code": "CUB",
"name": "Cuba",
"type": "COUNTRY"
},
{
"code": "CUW",
"name": "Curaçao",
"type": "COUNTRY"
},
{
"code": "DOM",
"name": "République dominicaine",
"type": "COUNTRY"
},
{
"code": "GRD",
"name": "Grenade",
"type": "COUNTRY"
},
{
"code": "GTM",
"name": "Guatemala",
"type": "COUNTRY"
},
{
"code": "HND",
"name": "Honduras",
"type": "COUNTRY"
},
{
"code": "JAM",
"name": "Jamaïque",
"type": "COUNTRY"
},
{
"code": "MEX",
"name": "Mexique",
"type": "COUNTRY"
},
{
"code": "PAN",
"name": "Panama",
"type": "COUNTRY"
},
{
"code": "PRI",
"name": "Porto Rico",
"type": "COUNTRY"
},
{
"code": "SLV",
"name": "Salvador",
"type": "COUNTRY"
},
{
"code": "SXM",
"name": "Saint-Martin (Pays-Bas)",
"type": "COUNTRY"
},
{
"code": "TCA",
"name": "îles Turques-et-Caïques",
"type": "COUNTRY"
},
{
"code": "USA",
"name": "États-Unis",
"type": "COUNTRY"
}
],
"tags": []
}
}
]
}
Updated over 1 year ago