States

Gets a list of all states.

get

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/states HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "countryCode": "US",
      "code": "NY",
      "name": "New York",
      "administrativeDivision": "North East",
      "tags": "State, US, NY"
    }
  ],
  "errors": []
}