org.list

TR50 Request

{
  "cmd": {
    "command": "org.list",
    "show": [
      "id",
      "key",
      "name",
      "profile",
      "lastLoginBy",
      "lastLoginOn",
      "createdBy",
      "createdOn",
      "updatedBy",
      "updatedOn"
    ]
  }
}

Request Parameters


Name	Type	Description
show	Array	An array of field names of the data columns to return.
offset	Integer	The starting list offset, used for pagination, defaults to 0 if not specified.
limit	Integer	Limits the number of results returned. Defaults to the maximum configured size.
sort	String	A string indicating the direction: (plus (+) for ascending, minus (-) for descending and the column by which to sort the results. To sort by the key in descending order, use -key. Defaults to "+key.
canHaveSubOrgs	Boolean	Whether to only list organizations that are capable of having child organizations.

TR50 Response

If the command is sent successfully a success message and the result is returned. Otherwise, an error and error message are returned.

{
  "cmd": {
    "success": true,
    "params": {
      "count": 42,
      "fields": [
        "id",
        "key",
        "name",
        "profile",
        "lastLoginBy",
        "lastLoginOn",
        "createdBy",
        "createdOn",
        "updatedBy",
        "updatedOn"
      ],
      "result": [
        {
          "id": "52a1d3db169e1fd032179408",
          "key": "SYSTEM",
          "name": "Test Open Management",
          "profile": "52a1d3db169e1fd032179408",
          "lastLoginBy": "admin@example.com",
          "lastLoginOn": "2013-12-06T08:40:43.885-05:00",
          "createdBy": "SYSTEM",
          "createdOn": "2013-12-06T08:40:43.885-05:00",
          "updatedBy": "SYSTEM",
          "updatedOn": "2013-12-06T08:40:43.885-05:00"
        }
      ]
    }
  }
}

Response Parameters


Name	Type	Description
count	Integer	Total number of available records for pagination.
fields	Array	An array of field names of data columns capable of being returned.
result	Array	Array of result objects.

Result Object


Name	Type	Description
id	String	The id of the organization.
key	String	The key of the organization.
name	String	The name of the organization.
desc	String	The description of the organization.
profile	String	The unique identifier of the org profile of the organization.
owner	String	The unique identifier of the owner of the organization.
locale	String	The default locale of the organization.
domain	String	The domain claimed by the organization.
customerRefId	String	The customer reference identifier.
allowSubOrgs	Boolean	Whether the organization allows child organizations.
parent	String	The unique identifier of the parent organization.
parentKey	String	The key of the parent organization.
ancestors	Array	The array of unique identifiers of the ancestor organizations.
ancestorKeys	Array	The array of keys of the ancestor organizations.
lastLoginBy	String	The last user who logged into the org.
lastLoginOn	String	The timestamp of the last login.
createdBy	String	The creator of the organization.
createdOn	String	The timestamp of the organization.
updatedBy	String	The updater of the organization.
updatedOn	String	The creation timestamp of the organization.