v1

latestOpenAPI 3.0.32026-07-26170311887.2 KB
States

List all States

Retrieve a list of states.

Required authorization scope: public.reference:read

This endpoint in only used for the United States, Canada, Australia and Mexico.

get/2024-09/states

Query parameters

pageinteger

Page number to fetch, default: 1

per_pageinteger

Number of records per page to fetch, default: 20

Response

list of states

Example response

{
  "states": [
    {
      "id": 1,
      "name": "Alabama",
      "abbr": "AL"
    }
  ]
}