Retrieve worklet catalog

Retrieves a list of Worklets

SecuritybearerAuth
Request
query Parameters
page
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0.

limit
integer [ 1 .. 500 ]
Default: 25

A limit on the number of results to be returned, between 1 and 500 with a default of 25. Use with page parameter.

sort
string

The field you want to sort by, in ascending or descending order. If the sort field and q field are absent, the default sort order is name:asc. If the sort field is absent and the q field is present, the default sort is by relevance.

Enum: "name:asc" "name:desc" "create_time:asc" "create_time:desc" "update_time:asc" "update_time:desc" "id:asc" "id:desc" "category:asc" "category:desc" "os_family:asc" "os_family:desc"
q
Array of strings

A search query to filter results by. The array should contain strings for name, os, keywords, and/or description. If the sort field and q field are absent, the default sort order is name:asc. If the sort field is absent and the q field is present, the default sort is by relevance.

Responses
200

Successful Operation

400

Invalid Request

401

Access token is missing or invalid

403

You do not have permission to perform this action.

404

Entity not found

429

Too many requests

503

Service Unavailable

default

Invalid Request

get/worklet-catalog
Request samples 
$apiKey = 'your_automox_api_key' $headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/worklet-catalog?page=0&limit=25&sort=name:asc&q=dbeaver,community
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers -ContentType "application/json").Content
Response samples
application/json
{
  • "uuid": "ab6a9bdc-95b8-5e82-a248-dafe2e40d5a7",
  • "name": "Add Network Printer",
  • "description": "This worklet will allow an Admin to add a network shared printer that installs at user logon.",
  • "category": "System Preferences",
  • "keywords": [
    • "task",
    • "logon",
    • "scheduled",
    • "printer",
    • "share",
    • "network"
    ],
  • "inputs": [ ],
  • "language": "PowerShell",
  • "status": "ACTIVE",
  • "creator": "Basil Fawlty",
  • "verified": true,
  • "version": "1.0.0",
  • "authors": [
    • {
      • "name": "Basil Fawlty",
      • "email": "example@automox.com"
      }
    ],
  • "categories": [
    • "System Preferences"
    ],
  • "bundles": [ ],
  • "refs": [ ],
  • "legacy_id": 4,
  • "user_interaction_required": false,
  • "os_family": "Windows",
  • "feature_compatibility": [ ],
  • "schema_version": "2.0.0",
  • "device_type": [
    • "SERVER",
    • "WORKSTATION"
    ],
  • "license_required": false,
  • "minimum_agent_required": "1.42.0",
  • "create_time": "2021-03-29T20:12:24Z",
  • "update_time": "2023-08-17T18:12:06Z"
}