Lookup Countries

Lookup Countries

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaclientcontacts.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=countries

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/clientcontacts.json?&version=6&action=countries&company=1

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/clientcontacts.json?&version=6&action=countries&company=1&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 13,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "countryCode": "",
      "countryName": "- Blank -",
      "variable_selected": true,
      "countryTimezoneCode": ""
    },
    {
      "countryCode": "AU",
      "countryName": "Australia",
      "variable_selected": false,
      "countryTimezoneCode": "UTC+10:00A"
    }
  ]
}