API Reference

Katapult Core API

Resources & Endpoints

Get country state

Return details for a specific country state.

GET
https://api.katapult.io/core/v1/country_states/{country_state}

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

country_state Required

The country state to return

 Country State Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

country_state_not_found

No country state was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    country_state: CountryState {
        id: String
        name: String
        code: String
        country: Country {
            id: String
            name: String
            iso_code2: String
            iso_code3: String
            time_zone: String?
            eu: Boolean
        }
    }
}