v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Subdivision

Retrieve Subdivision

Retrieves a specific Subdivision.

get/public/user/subdivision/retrieve/{subdivision_id}

Path parameters

subdivision_idstring required

ID of the Subdivision to retrieve

Response

Successful Subdivision Retrieve

messagestring

Status message for the retrieval.

Example response

{
  "data": {
    "country_id": "fr",
    "subdivision_alias": "fr_idf",
    "subdivision_id": "fr-idf",
    "subdivision_name": "Île-de-France",
    "subdivision_node_count": 1345
  },
  "message": "Subdivision successfully retrieved."
}