Sign in
State Controller

Get states with filters

Retrieve states with optional filters for country, active status, and search

get/states

Query parameters

countryIdnumber
Example:1

Filter by country ID

isActiveboolean
Example:true

Filter by active status

searchstring
Example:California

Search by state name

pagenumber required

Page number for pagination

sizenumber required
Example:10

Number of items per page

Response

States retrieved successfully

idnumber required

State ID

countryIdnumber required

ID of the country this state belongs to

stateNamestring required

State name

externalLinkstring nullable required

External domain URL for this state

isActiveboolean required

Active status of the state

isDeletedboolean required

Deleted status of the state

Example response

[
  {
    "id": 1,
    "countryId": 1,
    "stateName": "California",
    "externalLink": "example.com",
    "isActive": true,
    "country": {
      "id": 1,
      "countryName": "United States",
      "currencyCode": "USD",
      "currencySymbol": "$",
      "mailFrom": "noreply@uklandregistryonline.org.uk",
      "supportMail": "support@uklandregistryonline.org.uk",
      "isActive": true,
      "emailSignature": "Best regards, Team",
      "displayName": "UK Land Registry"
    }
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.