Get state by ID

Retrieve a specific state by its ID

get/states/{id}

Path parameters

idnumber required

Response

State 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.