org.find

TR50 Request

{
  "cmd": {
    "command": "org.find",
    "params": {
      "key": "SYSTEM"
    }
  }
}

Request Parameters


Name	Type	Description
id	String	The id identifying the organization.
key	String	The key identifying the organization.
domain	String	Looks up the organization that has claimed this domain (for example, example.com). Overrides the key parameter.

Note:

If none of the fields above are specified, org.find returns the organization you are currently in.

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": {
      "id": "52a1d3db169e1fd032179408",
      "key": "SYSTEM",
      "name": "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
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.
tags	Array	The organization's tags.
customerRefId	String	The customer reference identifier.
allowSubOrgs	Boolean	Whether the organization allows child organizations.
allowSubOrgsDeletion	Boolean	Wether the child organizations can be deleted.
apiRateLimit	Integer	The API rate limit for the organization in calls per second. Can only be set by a super-ops.
triggerRateLimit	Integer	The Trigger rate limit for the organization in calls per second. Can only be set by a super-ops.
apiCounts	Array	Contains the number of organization api counts for the last thirty days.
counts	Array	Contains the organization counts of things, connections, and storage.
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.
notes	String	The notes of the organization. Only available to users with Super Admin rights.
suspended	Boolean	Whether the organization is suspended.
suspendedReason	String	If the organization was suspended, what the reason is.
data	Object	Opaque data store object.
comments	Array	An array of Organization Comment objects. Only available to users with Super Ops rights.
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.

Org Comment Object

The org comment object is only available to users with Super Ops rights.


Name	Type	Description
id	String	The unique ID of the org comment.
orgId	String	The unique ID of the org this comment belongs to.
comment	String	The comment.
createdBy	String	The creator of the org comment.
createdOn	String	The creation timestamp of the org comment.