Skip to main content
This endpoint returns all command results.

​
Sample Request

curl -X GET https://console.jumpcloud.com/api/commandresults \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key:{API_KEY}'

​
Basic Parameters

ParameterDescription
FieldsUse a space separated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
FilterA filter to apply to the query. See the supported operators below. For more complex searches,
see the related /search/<domain> endpoints,
e.g. /search/systems.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are:
- $eq (equals)
- $ne (does not equal)
- $gt (is greater than)
- $gte (is greater than or equal to)
- $lt (is less than)
- $lte (is less than or equal to)

Note: v1 operators differ from v2 operators.

Note: For v1 operators, excluding the $ will result in undefined behavior.

value = Populate with the value you want to search for. Is case sensitive.

Examples
- GET /users?filter=username:$eq:testuser
- GET /systemusers?filter=password_expiration_date:$lte:2021-10-24
- GET /systemusers?filter=department:$ne:Accounting
- GET /systems?filter[0]=firstname:$eq:foo&filter[1]=lastname:$eq:bar - this will
AND the filters together.
- GET /systems?filter[or][0]=lastname:$eq:foo&filter[or][1]=lastname:$eq:bar - this will
OR the filters together.
SortUse space separated sort parameters to sort the collection.
Default sort is ascending. Prefix with - to sort descending.

​
Advanced Parameters

ParameterDescription
LimitThe number of records to return at once. Limited to 100.
Organization IDOrganization identifier that can be obtained from console settings.
SkipThe offset into the records to return.

​
Example Output

{
	"results": [
		{
			"_id": "string",
			"command": "string",
			"exitCode": 0,
			"name": "string",
			"requestTime": "2019-08-24T14:15:22Z",
			"responseTime": "2019-08-24T14:15:22Z",
			"sudo": true,
			"system": "string",
			"systemId": "string",
			"user": "string",
			"workflowId": "string"
		}
	],
	"totalCount": 0
}

​
Workflow Library Example

List Command Results with Jumpcloud and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop