Subdivision

Retrieve Subdivision

Retrieves a specific Subdivision.

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

Request

Base URL
https://api.byteful.com/1.0
Auth
API key in header X-API-Private-Key and API key in header X-API-Public-Key
TypeScript
https://skmtc.dev/byteful/apis/byteful-public-user-api/docs/public/user/subdivision/retrieve/:subdivision_id/get.ts
A function with typed inputs. Its response is checked against the schema.

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."
}

Changes

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