Organizations

Organizations

The Organizations call retrieves a list of organizations within the specified view and company the user has access to.

Deprecated - see Client list

  <th>
    Description
  </th>

  <th>
    Examples
  </th>

  <th>
    More info
  </th>
</tr>

  <td>
    Parameters described in overview
  </td>

  <td>
    user=user&password=user
  </td>

  <td>
    [Overview](ref:overview-2)
  </td>
</tr>

<tr>
  <td>
    <input mandatory>company</input>
  </td>

  <td>
    Company ID
  </td>

  <td>
    &company=1
  </td>
</tr>

<tr>
  <td>
    <input optional>clientcode:</input>
  </td>

  <td>
    Clientcode
  </td>

  <td>
    &clientcode=1/P0908
  </td>
</tr>

<tr>
  <td>
    <input optional>search:</input>
  </td>

  <td>
    Search Criteria
  </td>

  <td>
    &search=test
  </td>
</tr>

<tr>
  <td>
    <input optional>rows:</input>
  </td>

  <td>
    No. of Records
  </td>

  <td>
    &rows=10
  </td>
</tr>

<tr>
  <td>
    <input optional>page:</input>
  </td>

  <td>
    No. of Pages
  </td>

  <td>
    &page=1
  </td>
</tr>

Example request:
Request to list organizations

http://<SERVER>/jsonapi/organizations.json?user=user&password=user&version=3.3&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