API Reference

Katapult Core API

Resources & Endpoints

List country states

Return a list of all country states for a specific country.

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

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

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

country Required

The country to return states for

 Country Lookup None

page

Integer 1

per_page

Integer 30

Potential Errors

The following errors may occur during this request.

Details HTTP status

country_not_found

No country 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.

{
    pagination: Pagination Details {
        current_page: Integer
        total_pages: Integer?
        total: Integer?
        per_page: Integer
        large_set: Boolean
    }
    country_states: [ CountryState {
        id: String
        name: String
    } ]
}