Skip to main content
GET
/
generals
/
states
List states / provinces
curl --request GET \
  --url https://api.piriod.com/generals/states/ \
  --header 'Authorization: <api-key>'
{
  "count": 142,
  "results": [
    {
      "id": "<string>",
      "code": "<string>",
      "name": "<string>",
      "country": "<string>"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Query Parameters

​
page
integer
default:1

Page number to retrieve (1-indexed).

Required range: x >= 1
​
page_size
integer
default:20

Number of items per page.

Required range: 1 <= x <= 100
​
country
string
​
name
string

Response

200 - application/json

Paginated state list.

​
count
integer
required

Total number of items matching the filter.

Example:

142

​
results
object[]
required

The items in the current page.

​
next
string<uri> | null

URL of the next page, or null if last page.

​
previous
string<uri> | null

URL of the previous page, or null if first page.