Skip to main content

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 requestDescription
GET countriesReturns 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:

PropertiesTypeDescription
IdnumberThe ID that Sync uses to identify the country.
keystringThe key is another way to identify the country in Sync.
descriptionstringCountry description (country name).
countryCodestringCountry 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

CountryCountry IdCountry CodeResources
Mexico1MXMexico resources
Colombia2COColombia resources