CH documentation

Appearance

General - Countries ​

Overview ​

This endpoint provides access to a list of country terms from the thesaurus. This endpoint is part of the API for querying and retrieving terms related to countries, which can be used in various applications such as form fields, dropdowns, or data validation. It returns a comprehensive list of country names and related information as defined in the thesaurus.

Endpoint ​

GET /api/v2013/thesaurus/domains/countries/terms

Headers ​

The request must include the following headers:

FieldTypeDescription
AcceptStringSpecifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the response should be in JSON format. This helps the server understand how to format the response to meet the client's expectations.
Content-TypeStringIndicates the format of the request body sent by the client. The allowed value is application/json, meaning that the data being sent to the server is formatted as JSON. This informs the server of the data type it should expect and how to process it accordingly.

Usages ​

TitleFieldSchema
CountrygovernmentIRCC
CountrygovernmentContact
CountrycountryNFP
CountrygovernmentMSR

Environment URLs ​

This API has two different endpoints for production and development environments. Use the appropriate endpoint based on your current environment.

  • PROD Endpoint: https://api.cbd.int/

    • This endpoint is used for accessing the production environment of the API. Use this endpoint for all live, real-world applications where you need to interact with the actual production data.

  • DEV Endpoint: https://api.cbddev.xyz/

    • This endpoint is for the development environment. Use this for testing, development, and staging purposes. It allows you to safely test your applications without affecting the live production data.

Playground ​

Swagger playground is loading, please wait...