Skip to main content
GET
/
public
/
user
/
subdivision
/
retrieve
/
{subdivision_id}
Retrieve Subdivision
curl --request GET \
  --url https://api.byteful.com/1.0/public/user/subdivision/retrieve/{subdivision_id} \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "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."
}

Authorizations

​
X-API-Private-Key
string
header
required

Private API key for user-level authentication.

​
X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Path Parameters

​
subdivision_id
string
required

ID of the Subdivision to retrieve

Response

200 - application/json

Successful Subdivision Retrieve

Subdivision retrieve was successful.

​
data
object

Retrieved Subdivision item details.

​
message
string

Status message for the retrieval.