GET api/Clients/List?parentID={parentID}

Gets all Clients you have access to in a basic list format

Request Information

URI Parameters

Name	Description	Type	Additional information
parentID	Optional integer ID of a Parent to filter on	integer	None.

Body Parameters

None.

Response Information

Resource Description

List of Clients and any relevant messages

GetObjectListResponse

Name	Description	Type	Additional information
Information	Array of information about objects	Collection of ObjectInformation	None.
Messages	Array of messages	Collection of Message	None.
ServerInformation	Relevant information regarding the Server	ServerInformation	None.
VersionInformation	Relevant information regarding the API's version	VersionInformation	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Messages": [
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    },
    {
      "Severity": 0,
      "MessageCode": 1,
      "CodeDesc": 2,
      "MessageText": "sample string 3",
      "RecordNumber": 4
    }
  ],
  "ServerInformation": {
    "CurrentTimeUTC": "2026-03-02T15:47:59.7481689+10:00",
    "BuildDateUTC": "2026-03-02T15:47:59.7481689+10:00"
  },
  "VersionInformation": {
    "Major": 1,
    "Minor": 8,
    "Hotfix": 0,
    "Beta": true,
    "Version": "1.8.0.BETA"
  },
  "Information": [
    {
      "ID": 1,
      "N": "sample string 2",
      "PID": 3,
      "PN": "sample string 4",
      "X": 5
    },
    {
      "ID": 1,
      "N": "sample string 2",
      "PID": 3,
      "PN": "sample string 4",
      "X": 5
    }
  ]
}