Country

Retrieve Country

Retrieves a specific Country.

get/public/user/country/retrieve/{country_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/country/retrieve/:country_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

country_idstring required

ID of the Country to retrieve

Response

Successful Country Retrieve

messagestring

Status message for the retrieval.

Example response

{
  "data": {
    "continent_id": "eu",
    "country_alias": "fr",
    "country_id": "fr",
    "country_is_european_union": true,
    "country_name": "France",
    "country_node_count": 1234
  },
  "message": "Country successfully retrieved."
}

Changes

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