get https://api-payment.inspireplatform.io/states
Overview
Get a list of all states.
A successful response contains an Object Array with state data objects. Each state object describes a region within a country and has the following properties:
Name | Type | Description |
---|---|---|
id | String | State ID |
name | String | State name |
code | String | A two letter code |
Note: To filter the output by country, pass the country ID in thecountryId
query parameter.
If you don't pass a country ID, all states for all countries will be returned ordered alphabetically.