Get States / Regions / Provinces
A States (or Region / Province) is a group of Cities, such as California (USA) or Quebec (Canada) that can be used to filter Events.
Returns all States/Regions in Alphabetical order by identifier.
Note: Available for United States, Canada, and Australia only.
Request
- Base URLhttps://api.data.jambase.com/v3
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Only include States with / without upcoming events. Omit for both.
The Country code in ISO 3166-1 alpha-2 format [docs].
The two-letter ISO 3166-1 alpha-2 code for a country.
- geoCountryIso2=US
Use a pipe (|) to include multiple countries.
- geoCountryIso2=US|CA
Geographic filters alone request the normal upcoming-events dataset, even on historically entitled subscriptions; dateModifiedFrom alone is not historical intent either. On plans with geo + historical search (Enterprise baseline, or granted by request), request history explicitly with a licensed past event-date window or expandPastEvents=true. For country-by-country historical backfills, prefer bounded eventDateFrom/eventDateTo windows with no expand flag needed. An authorized historical request with no lower event-date bound receives the later fixed subscription date and rolling plan/override floor before origin fetch; truly unlimited history gets no invented floor. Iterate only countries that actually have data for your target date range (ask support for the coverage list) rather than sweeping every ISO code. Note the code for the United Kingdom is GB, not UK — source data occasionally shows UK, but this filter expects GB.
The Country code in ISO 3166-1 alpha-3 format [docs].
The three-letter ISO code for a country.
- geoCountryIso3=USA
Use a pipe (|) to include multiple countries.
- geoCountryIso3=USA|CAN
Response
A list of States
Example response
{
"pagination": {
"page": 1,
"perPage": 10,
"totalItems": 50,
"totalPages": 5
},
"states": [
{
"identifier": "US-AZ",
"name": "Arizona",
"alternateName": "AZ",
"country": {
"identifier": "US",
"name": "United States",
"alternateName": "USA",
"x-numUpcomingEvents": 12
},
"x-numUpcomingEvents": 12
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.