GET
/
api
/
v2
/
platform
/
states
Returns a list of States
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/states \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "230",
      "type": "state",
      "attributes": {
        "name": "STATE_NAME_230",
        "abbr": "STATE_ABBR_230",
        "updated_at": "2022-11-08T19:35:26.719Z",
        "created_at": "2022-11-08T19:35:26.719Z"
      },
      "relationships": {
        "country": {
          "data": {
            "id": "394",
            "type": "country"
          }
        }
      }
    },
    {
      "id": "231",
      "type": "state",
      "attributes": {
        "name": "STATE_NAME_231",
        "abbr": "STATE_ABBR_231",
        "updated_at": "2022-11-08T19:35:26.721Z",
        "created_at": "2022-11-08T19:35:26.721Z"
      },
      "relationships": {
        "country": {
          "data": {
            "id": "394",
            "type": "country"
          }
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/states?page=1&per_page=&include=&filter[country_id_eq]=",
    "next": "http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/states?filter%5Bcountry_id_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[country_id_eq]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.