Countries

Countries Management

This section provides a comprehensive guide to managing the cities in our system. You will find various options for retrieving, filtering, and setting city information, each tailored to different requirements.

Country Retrieval

Get All Countries

  • Endpoint: /get_countries
  • Description: This endpoint is designed to retrieve the complete list of cities available in our database, providing a comprehensive overview of all cities without applying any filters.
  • Usage Notes:
    • Pagination: To manage data effectively, this endpoint supports fetching up to 50 cities at a time.
    • Parameters:
    • offset - Specify the starting point of the row from which to begin fetching cities.
    • limit - Control the number of cities returned in a single request. The maximum limit is 50, but you can opt for a smaller number based on your needs.
    • Method: This functionality can be utilized by including payload or parameters in your POST request to manage the offset and limit.

These features are particularly useful for handling large datasets and for applications requiring batch processing of city information.



Filters

IN / NOT_IN Filter

  • Endpoint: /get_countries
  • Description: Use this endpoint to filter cities based on specific city IDs. It supports both inclusion (IN) and exclusion (NOT_IN) filters for city IDs.
  • Parameters:
    • IN - Specify the city IDs to include specific cities.
    • NOT_IN - Specify the city IDs to exclude specific cities.
    • You can use these parameters as arrays or single integers for more flexibility.

Setting Country Information

Set Countries

  • Endpoint: countries are all pre-defined and there is no setter API call for countries, incase of a flag or name upgrade or even insertion please contact our support API Support

For further assistance or API integration support, please refer to our API Support or contact our technical support team.