Overview
Sync organizes its data by country, allowing access to the available states and resources for each one. Each Country object contains the general information of a country (such as its name and code).
This structure enables country-specific operations and queries across the Sync platform.
Methods
The API supports the following methods for Country objects:
| HTTP request | Description |
|---|---|
| GET countries | Returns a collection containing all available countries in Sync. |
Object representation
{
"id": number,
"key": string,
"description": string,
"countryCode": string,
}
Properties
The following table defines the properties that appear in this object:
| Properties | Type | Description |
|---|---|---|
| Id | number | The ID that Sync uses to identify the country. |
| key | string | The key is another way to identify the country in Sync. |
| description | string | Country description (country name). |
| countryCode | string | Country code. |
Available countries
The following table showcases the available countries that have resources in Sync, each with its corresponding country code, country name, and resources link to the resources available in that country.
Table
| Country | Country Id | Country Code | Resources |
|---|---|---|---|
| Mexico | 1 | MX | Mexico resources |
| Colombia | 2 | CO | Colombia resources |