Organizations

List of organizations

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areaorganizations.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.8v3.8 Overview
CompanyYesThe company numbercompany=1
clientcodeNoClient codeclientcode=1/P0908
searchNoSearch Criteriasearch=test

Example request:

http://<SERVER>/jsonapi/organizations.json?user=user&password=user&version=3.8&company=1

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "clientUuid": "A246FBB5E59C41A1AC29A00A8F82FC66",
      "clientTimeStampModified": 1520523773,
      "clientRecordVersionNumber": 107,
      "clientCustomField196": "a",
      "clientCustomField204": "xxxyyyzzz",
      "clientCustomField211": "2018-03-07",
      "clientCustomField260": "a - 1",
      "clientCustomField296": "1ccccc",
      "clientCustomField315": false,
      "clientCustomField323": "Crunchy grass",
      "clientCode": "1/P0908",
      "clientName": "4imprint1",
      "clientCategoryName": "Client",
      "clientPhone": "",
      "clientCategory": 3,
      "clientHandlerUserID": 533,
      "clientWebURL": "",
      "clientEmail": "",
      "clientInactive": false,
      "clientType": "Food 1",
      "clientOpStatus": "Silver",
      "clientMarketSector": "Food and drink",
      "clientOnHold": false,
      "clientHandlerFullName": "Gina Labro"
    }
  ]
}

Note: Feature from API 2.2