Countries

Some data, especially addresses are tied to a Country, which is listed in CRM CareCloud. You can get here the list of countries available.

Available methods

All available methods for resource countries.

HTTP method Endpoint Description
[badge-blue GET] /countries Get information about all countries

Get all countries

Get a list of countries accepted in CRM CareCloud
[badge-blue GET ] /countries

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
country_id string The unique id of the country as ISO code
state integer State of the country
Possible values are: 0 - deleted / 1- active / 2 - non active
total_items integer Count of all found countries

Example request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/countries
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmU2ZTBkMjg4MDllMzM3DdjNGEmEyZGFjZ3NmUzNDljNGYyMzlkOWEwZmQyM2Q0NA0NA0NA==

Example response

HTTP/1.1 200 OK
Date: Tue, 04 Aug 2020 11:37:20 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "countries": [
      {
        "country_id": "sk",
        "state": 1
      },
      {
        "country_id": "cz",
        "state": 1
      }
    ],
    "total_items": 2
  }
}