read thedocs.

[ docs // guides & reference ]

Connector setup guides, tool references, auth flows, and platform concepts — everything you need to run StackJack, in one place.

34 connectors documented // 6,712 tools referenced // setup, auth & platform guides

No pages match that search. Clear it

← All documentation

SuperOps Tools

superops_ · 139 tools · Free 76 · Pro 63 GraphQL (StackJack's first): one POST /msp endpoint per region (api.superops.ai US default / euapi.superops.ai EU) with the operation chosen by the query document; static two-component auth (Authorization: Bearer + a mandatory CustomerSubDomain header); offset pagination via ListInfoInput { page (1-based), pageSize (max 100), condition, sort } with listInfo.hasMore; logical failures return HTTP 200 with a top-level errors[] array (raw JSON passthrough); update mutations treat an explicit null as clear-the-field, so tools expose a clearFields parameter; dates are UTC ISO-8601; run_query/run_mutation are generic escape hatches.

Assets & Monitoring

Tool Plan Access Description
superops_assign_device_category Pro Write [SuperOps] Assign a device category to one or more assets. Provide a JSON object body identifying the target asset(s) and the device category to assign. Discover assetIds with superops_get_asset_list. Returns the raw GraphQL JSON body.
superops_get_asset Free Read-only [SuperOps] Fetch a single RMM asset (managed device) by its assetId. Returns the raw GraphQL JSON body ({data:{getAsset:}} or {errors:[...]}). Discover assetIds with superops_get_asset_list. For deeper detail on one asset use superops_get_asset_summary, superops_get_asset_disk_details, superops_get_asset_software_list, superops_get_asset_patch_details, or superops_get_asset_activity.
superops_get_asset_activity Free Read-only [SuperOps] Fetch the activity/event history for one asset by assetId. Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list.
superops_get_asset_custom_fields Free Read-only [SuperOps] Fetch the custom-field values set on one asset by assetId. Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list.
superops_get_asset_disk_details Free Read-only [SuperOps] Fetch disk/volume details for one asset by assetId (capacity, free space, file systems). Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list.
superops_get_asset_info_by_tp_endpoint_ids Free Read-only [SuperOps] Resolve SuperOps assets from third-party (integration) endpoint IDs. Provide one or more endpoint IDs from an integrated RMM/tool; returns the matching SuperOps assets as raw GraphQL JSON.
superops_get_asset_list Free Read-only [SuperOps] List RMM assets (managed devices), paginated. page is 1-based; pageSize is capped at 100. condition and sort are optional JSON (SuperOps ListInfoInput.condition / .sort) for filtering and ordering. The response's listInfo.hasMore indicates whether another page exists. Use the returned assetId with superops_get_asset.
superops_get_asset_patch_details Free Read-only [SuperOps] Fetch patch detail for one asset by assetId (the individual patches known for the device). Returns the raw GraphQL JSON body. For a compliance rollup use superops_get_asset_patch_status. Discover assetIds with superops_get_asset_list.
superops_get_asset_patch_status Free Read-only [SuperOps] Fetch patch compliance/status for one asset by assetId (installed vs missing counts, last scan). Returns the raw GraphQL JSON body. For the individual patches use superops_get_asset_patch_details. Discover assetIds with superops_get_asset_list.
superops_get_asset_software_list Free Read-only [SuperOps] Fetch the installed-software inventory for one asset by assetId. Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list.
superops_get_asset_summary Free Read-only [SuperOps] Fetch a rollup/summary for one asset by assetId (health, status, last-reported). Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list.
superops_get_asset_user_log Free Read-only [SuperOps] Fetch the logged-in-user history for one asset by assetId. Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list.
superops_get_unmonitored_asset_list Free Read-only [SuperOps] List assets that are NOT under monitoring, paginated. page is 1-based; pageSize is capped at 100. condition and sort are optional JSON (SuperOps ListInfoInput.condition / .sort). The response's listInfo.hasMore indicates whether another page exists.
superops_run_script_on_asset Pro Destructive [SuperOps] Execute an RMM script on an asset (endpoint). This runs code on the remote device and can change or damage its state — use with care. Provide a JSON object body (the SuperOps run-script input) identifying the target asset(s) and the script to run (plus any runtime arguments). Discover assetIds with superops_get_asset_list and scriptIds with superops_get_script_list. Returns the raw GraphQL JSON body.
superops_soft_delete_asset Pro Destructive [SuperOps] Soft-delete an RMM asset by assetId (moves it to a recoverable deleted state). Discover assetIds with superops_get_asset_list. Returns the raw GraphQL JSON body.
superops_update_asset Pro Write [SuperOps] Update attributes of an existing RMM asset. inputJson is the SuperOps UpdateAssetInput object and MUST identify the asset (e.g. its assetId) plus the fields to change. IMPORTANT null-reset semantics: OMIT a field to leave it unchanged. To CLEAR a field, list its name in clearFields (emitted as an explicit JSON null) — do not put a field you want to keep in clearFields. Discover assetIds with superops_get_asset_list. Returns the raw GraphQL JSON body.
superops_assign_device_category parameters
Param Type Required Default Description
inputJson string yes JSON object body identifying the target asset(s) and the device category to assign (e.g. assetIds and a categoryId/deviceCategory).
superops_get_asset parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_activity parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_custom_fields parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_disk_details parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_info_by_tp_endpoint_ids parameters
Param Type Required Default Description
endpointIds array yes Third-party endpoint identifiers to resolve to SuperOps assets.
superops_get_asset_list parameters
Param Type Required Default Description
condition string no null Optional filter as a JSON object/array (SuperOps ListInfoInput.condition). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, max 100).
sort string no null Optional sort as a JSON array (SuperOps ListInfoInput.sort). Omit for the default order.
superops_get_asset_patch_details parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_patch_status parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_software_list parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_summary parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_asset_user_log parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_unmonitored_asset_list parameters
Param Type Required Default Description
condition string no null Optional filter as a JSON object/array (SuperOps ListInfoInput.condition). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, max 100).
sort string no null Optional sort as a JSON array (SuperOps ListInfoInput.sort). Omit for the default order.
superops_run_script_on_asset parameters
Param Type Required Default Description
inputJson string yes JSON object body identifying the target asset(s) and the script to run (e.g. assetId/assetIds, scriptId, and any script arguments).
superops_soft_delete_asset parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier to soft-delete (from superops_get_asset_list).
superops_update_asset parameters
Param Type Required Default Description
clearFields array no null Field names to CLEAR (reset to null) on the asset. Only include a field here if you intend to wipe its value. Omit or empty for none.
inputJson string yes JSON object body (SuperOps UpdateAssetInput). Must identify the asset (e.g. assetId) and carry the fields to change. Omit a key to leave it unchanged; list names in clearFields to blank them.

Alerts & Scripts

Tool Plan Access Description
superops_create_alert Pro Write [SuperOps] Raise a new RMM alert. Provide a JSON object body (the SuperOps create-alert input) — typically the alerting asset plus a severity and message. Returns the raw GraphQL JSON body with the created alert. To close alerts use superops_resolve_alerts.
superops_get_alert_list Free Read-only [SuperOps] List RMM alerts, paginated. page is 1-based; pageSize is capped at 100. condition and sort are optional JSON (SuperOps ListInfoInput.condition / .sort) for filtering (e.g. by severity or status) and ordering. The response's listInfo.hasMore indicates whether another page exists. For alerts on a single device use superops_get_alerts_for_asset.
superops_get_alerts_for_asset Free Read-only [SuperOps] Fetch the RMM alerts scoped to a single asset by assetId. Returns the raw GraphQL JSON body. Discover assetIds with superops_get_asset_list; for an unscoped, paginated alert feed use superops_get_alert_list.
superops_get_script_list Free Read-only [SuperOps] List RMM scripts, paginated. page is 1-based; pageSize is capped at 100. condition and sort are optional JSON (SuperOps ListInfoInput.condition / .sort). The response's listInfo.hasMore indicates whether another page exists. To filter to one script type use superops_get_script_list_by_type. Use a returned scriptId with superops_run_script_on_asset.
superops_get_script_list_by_type Free Read-only [SuperOps] List RMM scripts filtered to a single script type, paginated. Provide the script type to filter on. page is 1-based; pageSize is capped at 100. condition and sort are optional JSON (SuperOps ListInfoInput.condition / .sort). The response's listInfo.hasMore indicates whether another page exists. For all scripts regardless of type use superops_get_script_list.
superops_resolve_alerts Pro Write [SuperOps] Resolve (close) one or more RMM alerts by their alertIds. Discover alertIds with superops_get_alert_list or superops_get_alerts_for_asset. Returns the raw GraphQL JSON body.
superops_create_alert parameters
Param Type Required Default Description
inputJson string yes JSON object body (SuperOps create-alert input) — e.g. the target asset, a severity, and a message.
superops_get_alert_list parameters
Param Type Required Default Description
condition string no null Optional filter as a JSON object/array (SuperOps ListInfoInput.condition). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, max 100).
sort string no null Optional sort as a JSON array (SuperOps ListInfoInput.sort). Omit for the default order.
superops_get_alerts_for_asset parameters
Param Type Required Default Description
assetId string yes The SuperOps asset identifier (from superops_get_asset_list).
superops_get_script_list parameters
Param Type Required Default Description
condition string no null Optional filter as a JSON object/array (SuperOps ListInfoInput.condition). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, max 100).
sort string no null Optional sort as a JSON array (SuperOps ListInfoInput.sort). Omit for the default order.
superops_get_script_list_by_type parameters
Param Type Required Default Description
condition string no null Optional filter as a JSON object/array (SuperOps ListInfoInput.condition). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, max 100).
sort string no null Optional sort as a JSON array (SuperOps ListInfoInput.sort). Omit for the default order.
type string yes The script type to filter on.
superops_resolve_alerts parameters
Param Type Required Default Description
alertIds array yes The alert identifiers to resolve (from superops_get_alert_list or superops_get_alerts_for_asset).

Clients

Tool Plan Access Description
superops_create_client Pro Write [SuperOps] Create a client (account). PREFER superops_create_client_v2 — this legacy variant is retained for parity but createClientV2 is the current-stable create with the richer input schema. inputJson is the CreateClientInput object (e.g. {"name":"...","stage":"...","emailDomains":["..."]}). Returns the raw SuperOps GraphQL JSON for the created client.
superops_create_client_v2 Pro Write [SuperOps] Create a client (account) using the current-stable V2 schema — PREFERRED over superops_create_client. inputJson is the CreateClientInputV2 object (e.g. {"name":"...","stage":"...","emailDomains":["..."],"primaryContact":}). Returns the raw SuperOps GraphQL JSON for the created client.
superops_get_client Free Read-only [SuperOps] Fetch a single client (account) by its accountId (from superops_get_client_list). Returns the raw SuperOps GraphQL JSON for the client. Related: superops_get_client_site_list, superops_get_client_user_list, superops_get_client_contract_list.
superops_get_client_list Free Read-only [SuperOps] List clients (accounts), paginated. Optional condition/sort filters as JSON strings. Returns the raw SuperOps GraphQL JSON including the listInfo.hasMore paging flag. Use superops_get_client for one client's full detail.
superops_hard_delete_clients Pro Destructive [SuperOps] PERMANENTLY delete one or more clients (accounts). DESTRUCTIVE and NOT recoverable — unlike superops_soft_delete_clients, hard-deleted clients cannot be restored. Provide the account ids to permanently remove.
superops_restore_clients Pro Write [SuperOps] Restore one or more soft-deleted clients (accounts) back to active state (reverses superops_soft_delete_clients; does NOT recover hard-deleted clients). Provide the account ids to restore.
superops_soft_delete_clients Pro Destructive [SuperOps] Soft-delete one or more clients (accounts) — they are moved to a deleted state and can be restored with superops_restore_clients. DESTRUCTIVE. Provide the account ids to remove.
superops_update_client Pro Write [SuperOps] Update a client (account). inputJson is the UpdateClientInput object and MUST carry the client's accountId plus the fields to change. To CLEAR a field, list its name in clearFields (emitted as explicit null); omit fields you want left unchanged. Returns the raw SuperOps GraphQL JSON for the updated client.
superops_create_client parameters
Param Type Required Default Description
inputJson string yes The CreateClientInput object as a JSON string (e.g. {"name":"Acme","stage":"ACTIVE"}). Confirm field names against your SuperOps schema.
superops_create_client_v2 parameters
Param Type Required Default Description
inputJson string yes The CreateClientInputV2 object as a JSON string. Confirm field names against your SuperOps schema.
superops_get_client parameters
Param Type Required Default Description
accountId string yes The client account id (accountId, from superops_get_client_list).
superops_get_client_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string (embedded verbatim as GraphQL). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string (embedded verbatim as GraphQL). Omit for default ordering.
superops_hard_delete_clients parameters
Param Type Required Default Description
clientIds array yes The account ids to permanently delete (from superops_get_client_list).
superops_restore_clients parameters
Param Type Required Default Description
clientIds array yes The account ids to restore (previously soft-deleted).
superops_soft_delete_clients parameters
Param Type Required Default Description
clientIds array yes The account ids to soft-delete (from superops_get_client_list).
superops_update_client parameters
Param Type Required Default Description
clearFields array no null Field names to CLEAR (reset to null) on the client, e.g. ["secondaryContact"]. Omit or empty for none.
inputJson string yes The UpdateClientInput object as a JSON string (must include the accountId + changed fields).

Client Custom Fields

Tool Plan Access Description
superops_create_client_custom_field Pro Write [SuperOps] Create a client custom-field definition. inputJson is the CreateClientCustomFieldInput object (e.g. {"name":"...","type":"..."}). Returns the raw SuperOps GraphQL JSON.
superops_get_client_custom_field Free Read-only [SuperOps] Fetch a single client custom-field definition/value. Supply the SuperOps identifier for the custom field as a raw JSON object string in inputJson (the CustomFieldIdentifierInput shape SuperOps documents, e.g. {"name":"<field name>"}). Returns the raw SuperOps GraphQL JSON. List all with superops_get_client_custom_field_list.
superops_get_client_custom_field_list Free Read-only [SuperOps] List client custom-field definitions/values, paginated. Returns the raw SuperOps GraphQL JSON including listInfo.hasMore.
superops_create_client_custom_field parameters
Param Type Required Default Description
inputJson string yes The CreateClientCustomFieldInput object as a JSON string.
superops_get_client_custom_field parameters
Param Type Required Default Description
inputJson string yes The client custom-field identifier as a raw JSON object string (per SuperOps docs, e.g. {"name":"<field name>"}).
superops_get_client_custom_field_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string. Omit for default ordering.

Client Stages

Tool Plan Access Description
superops_get_client_stage_list Free Read-only [SuperOps] List client lifecycle stages (the account-stage lookup used when creating/updating a client), paginated. Returns the raw SuperOps GraphQL JSON including listInfo.hasMore.
superops_get_client_stage_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string. Omit for default ordering.

Client Sites

Tool Plan Access Description
superops_create_client_site Pro Write [SuperOps] Create a client site. inputJson is the CreateClientSiteInput object (references the client's accountId plus site name/address/timezone). Returns the raw SuperOps GraphQL JSON for the created site.
superops_delete_client_sites Pro Destructive [SuperOps] Delete one or more client sites. DESTRUCTIVE. Provide the site ids to remove (a client's headquarters site typically cannot be deleted while the client exists).
superops_get_client_site Free Read-only [SuperOps] Fetch a single client site by its id (from superops_get_client_site_list). Returns the raw SuperOps GraphQL JSON including the site address and contact scalars.
superops_get_client_site_list Free Read-only [SuperOps] List client sites, paginated. Optional condition/sort filters as JSON strings (e.g. filter by a client's accountId). Returns the raw SuperOps GraphQL JSON including listInfo.hasMore.
superops_update_client_site Pro Write [SuperOps] Update a client site. inputJson is the UpdateClientSiteInput object and MUST carry the site id plus the fields to change. To CLEAR a field, list its name in clearFields (emitted as explicit null); omit fields you want left unchanged. Returns the raw SuperOps GraphQL JSON.
superops_create_client_site parameters
Param Type Required Default Description
inputJson string yes The CreateClientSiteInput object as a JSON string.
superops_delete_client_sites parameters
Param Type Required Default Description
siteIds array yes The site ids to delete (from superops_get_client_site_list).
superops_get_client_site parameters
Param Type Required Default Description
id string yes The client site id (from superops_get_client_site_list).
superops_get_client_site_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string. Omit for default ordering.
superops_update_client_site parameters
Param Type Required Default Description
clearFields array no null Field names to CLEAR (reset to null) on the site, e.g. ["line2"]. Omit or empty for none.
inputJson string yes The UpdateClientSiteInput object as a JSON string (must include the site id + changed fields).

Client Users

Tool Plan Access Description
superops_create_client_user Pro Write [SuperOps] Create a client user (requester). inputJson is the CreateClientUserInput object (references the client's accountId plus name/email/role/site). Returns the raw SuperOps GraphQL JSON for the created user.
superops_create_client_user_associations Pro Write [SuperOps] Create one or more client↔user associations (link a client user to a client, and optionally a site, with a role). inputJson is the association input object/array. Returns the raw SuperOps GraphQL JSON.
superops_delete_client_user Pro Destructive [SuperOps] Delete a single client user (requester). DESTRUCTIVE. Provide the userId to remove.
superops_delete_client_user_associations Pro Destructive [SuperOps] Delete one or more client↔user associations (unlink users from clients/sites). DESTRUCTIVE. Provide the association ids to remove.
superops_get_client_user Free Read-only [SuperOps] Fetch a single client user (requester) by userId (from superops_get_client_user_list). Returns the raw SuperOps GraphQL JSON for the user.
superops_get_client_user_association_list Free Read-only [SuperOps] List client↔user associations, paginated. Optional condition/sort filters as JSON strings. Returns the raw SuperOps GraphQL JSON including listInfo.hasMore.
superops_get_client_user_list Free Read-only [SuperOps] List client users (requesters), paginated. Optional condition/sort filters as JSON strings (e.g. filter by a client's accountId). Returns the raw SuperOps GraphQL JSON including listInfo.hasMore.
superops_update_client_user Pro Write [SuperOps] Update a client user (requester). inputJson is the UpdateClientUserInput object and MUST carry the userId plus the fields to change. To CLEAR a field, list its name in clearFields (emitted as explicit null); omit fields you want left unchanged. Returns the raw SuperOps GraphQL JSON.
superops_update_client_user_associations Pro Write [SuperOps] Update one or more client↔user associations (e.g. change a user's role or site link). inputJson is a JSON ARRAY of UpdateClientUserAssociationInput objects, each identifying an association plus the fields to change (the mutation is a batch). Returns the raw SuperOps GraphQL JSON.
superops_create_client_user parameters
Param Type Required Default Description
inputJson string yes The CreateClientUserInput object as a JSON string.
superops_create_client_user_associations parameters
Param Type Required Default Description
inputJson string yes A JSON ARRAY string of CreateClientUserAssociationInput objects (the mutation is a batch — supply one or more, e.g. []).
superops_delete_client_user parameters
Param Type Required Default Description
userId string yes The client user id (userId, from superops_get_client_user_list) to delete.
superops_delete_client_user_associations parameters
Param Type Required Default Description
associationIds array yes The client-user-association ids to delete (from superops_get_client_user_association_list).
superops_get_client_user parameters
Param Type Required Default Description
userId string yes The client user id (userId, from superops_get_client_user_list).
superops_get_client_user_association_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string. Omit for default ordering.
superops_get_client_user_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string. Omit for default ordering.
superops_update_client_user parameters
Param Type Required Default Description
clearFields array no null Field names to CLEAR (reset to null) on the user, e.g. ["reportingManager"]. Omit or empty for none.
inputJson string yes The UpdateClientUserInput object as a JSON string (must include the userId + changed fields).
superops_update_client_user_associations parameters
Param Type Required Default Description
inputJson string yes A JSON ARRAY string of UpdateClientUserAssociationInput objects (each identifies an association + the fields to change).

Client Contracts

Tool Plan Access Description
superops_create_client_contract Pro Write [SuperOps] Create a client contract. inputJson is the CreateClientContractInput object (typically references the client's accountId plus contract terms/dates). Returns the raw SuperOps GraphQL JSON for the created contract.
superops_get_client_contract Free Read-only [SuperOps] Fetch a single client contract by its contractId (from superops_get_client_contract_list). Returns the raw SuperOps GraphQL JSON for the contract.
superops_get_client_contract_list Free Read-only [SuperOps] List client contracts, paginated. Optional condition/sort filters as JSON strings (e.g. filter by a client's accountId). Returns the raw SuperOps GraphQL JSON including listInfo.hasMore.
superops_update_client_contract Pro Write [SuperOps] Update a client contract. inputJson is the UpdateClientContractInput object and MUST carry the contractId plus the fields to change. To CLEAR a field, list its name in clearFields (emitted as explicit null); omit fields you want left unchanged. Returns the raw SuperOps GraphQL JSON.
superops_create_client_contract parameters
Param Type Required Default Description
inputJson string yes The CreateClientContractInput object as a JSON string.
superops_get_client_contract parameters
Param Type Required Default Description
contractId string yes The contract id (contractId, from superops_get_client_contract_list).
superops_get_client_contract_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object string. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Results per page, 1-100 (default 50; hard-capped at 100).
sortJson string no null Optional SuperOps `sort` as a JSON array string. Omit for default ordering.
superops_update_client_contract parameters
Param Type Required Default Description
clearFields array no null Field names to CLEAR (reset to null) on the contract. Omit or empty for none.
inputJson string yes The UpdateClientContractInput object as a JSON string (must include the contractId + changed fields).

Tickets

Tool Plan Access Description
superops_create_ticket Pro Write [SuperOps] Create a ticket. Supply the full CreateTicketInput as a raw JSON object string in inputJson (per SuperOps docs — typically subject, requester/client, and any priority/status/technician references). All dates are UTC ISO-8601. Returns the new { ticketId, displayId }. Read it back with superops_get_ticket; edit with superops_update_ticket.
superops_create_ticket_conversation Pro Write [SuperOps] Add a public conversation/reply to a ticket. Supply the CreateTicketConversationInput as a raw JSON object string in inputJson (per SuperOps docs — typically the ticketId plus the reply content). Returns the new . Read the thread with superops_get_ticket_conversation_list. For an internal note use superops_create_ticket_note.
superops_create_ticket_custom_field Pro Write [SuperOps] Create a ticket custom-field definition. Supply the CreateTicketCustomFieldInput as a raw JSON object string in inputJson (per SuperOps docs — typically the field name, label, and type). Returns the new field's . List ticket custom fields with superops_get_ticket_custom_field_list.
superops_create_ticket_note Pro Write [SuperOps] Add an internal note to a ticket (not visible to the requester). Supply the CreateTicketNoteInput as a raw JSON object string in inputJson (per SuperOps docs — typically the ticketId plus the note content). Returns the new . Read notes with superops_get_ticket_note_list.
superops_get_ticket Free Read-only [SuperOps] Fetch a single ticket by its ticketId. Pass the ticketId from superops_get_ticket_list. Returns the ticket's core identity fields (ticketId, displayId, subject, createdTime, updatedTime). For status/priority/requester/technician and other nested fields, use superops_run_query with an expanded selection set. Use superops_get_ticket_conversation_list and superops_get_ticket_note_list for the thread, and superops_update_ticket / superops_soft_delete_tickets to modify it.
superops_get_ticket_conversation_list Free Read-only [SuperOps] List the public conversation/reply thread for a ticket. Pass the ticketId (from superops_get_ticket_list); the SuperOps getTicketConversationList(input: TicketIdentifierInput!) read returns the ticket's conversation thread as raw GraphQL JSON. For internal notes use superops_get_ticket_note_list.
superops_get_ticket_custom_field Free Read-only [SuperOps] Fetch a single ticket custom-field definition/value. Supply the SuperOps identifier for the custom field as a raw JSON object string in inputJson (the shape SuperOps documents for the custom-field identifier, e.g. {"name":"<field name>"}). Returns { name, value }. List all with superops_get_ticket_custom_field_list; create one with superops_create_ticket_custom_field.
superops_get_ticket_custom_field_list Free Read-only [SuperOps] List ticket custom fields (paginated). Offset pagination via page (1-based) and pageSize (max 100); optional conditionJson / sortJson raw-JSON filters go into ListInfoInput. Returns { customFields [...], listInfo { totalCount, hasMore } }. For the full field-definition catalog across modules use superops_get_all_fields.
superops_get_ticket_list Free Read-only [SuperOps] List tickets (paginated). Offset pagination via page (1-based) and pageSize (max 100). Optionally narrow/order results with conditionJson (a SuperOps search condition object) and sortJson (a sort array), both raw JSON strings passed straight into ListInfoInput. Returns { tickets [...], listInfo { totalCount, hasMore } }; walk pages while listInfo.hasMore is true. Use the returned ticketId with superops_get_ticket.
superops_get_ticket_note_list Free Read-only [SuperOps] List the internal notes on a ticket. Pass the ticketId (from superops_get_ticket_list); the SuperOps getTicketNoteList(input: TicketIdentifierInput!) read returns the ticket's internal notes as raw GraphQL JSON. Add a note with superops_create_ticket_note.
superops_hard_delete_tickets Pro Destructive [SuperOps] PERMANENTLY delete one or more trashed tickets. Supply inputJson as a raw JSON ARRAY of TicketIdentifierInput objects (e.g. [{"ticketId":"<id>"}]). This is irreversible and cannot be restored — soft-delete first with superops_soft_delete_tickets if you may need recovery.
superops_restore_tickets Pro Write [SuperOps] Restore one or more soft-deleted (trashed) tickets. Supply inputJson as a raw JSON ARRAY of TicketIdentifierInput objects (e.g. [{"ticketId":"<id>"}]). Only tickets currently in the trash (from superops_soft_delete_tickets) can be restored; hard-deleted tickets are gone.
superops_soft_delete_tickets Pro Destructive [SuperOps] Soft-delete (move to trash) one or more tickets. Supply inputJson as a raw JSON ARRAY of TicketIdentifierInput objects (e.g. [{"ticketId":"<id>"}]). Soft-deleted tickets can be recovered with superops_restore_tickets; to permanently remove trashed tickets use superops_hard_delete_tickets.
superops_update_ticket Pro Write [SuperOps] Update a ticket. Supply the UpdateTicketInput as a raw JSON object string in inputJson (must include the ticketId plus the fields to change). IMPORTANT: only include fields you intend to change — an explicitly-null field CLEARS/resets it, while omitting a field leaves it unchanged. To intentionally blank one or more fields, list their names in clearFields (comma-separated) instead of guessing the null shape. Returns the updated .
superops_create_ticket parameters
Param Type Required Default Description
inputJson string yes The full CreateTicketInput as a raw JSON object string (per SuperOps docs).
superops_create_ticket_conversation parameters
Param Type Required Default Description
inputJson string yes The CreateTicketConversationInput as a raw JSON object string (per SuperOps docs).
superops_create_ticket_custom_field parameters
Param Type Required Default Description
inputJson string yes The CreateTicketCustomFieldInput as a raw JSON object string (per SuperOps docs).
superops_create_ticket_note parameters
Param Type Required Default Description
inputJson string yes The CreateTicketNoteInput as a raw JSON object string (per SuperOps docs).
superops_get_ticket parameters
Param Type Required Default Description
ticketId string yes The ticketId of the ticket to fetch (from superops_get_ticket_list).
superops_get_ticket_conversation_list parameters
Param Type Required Default Description
ticketId string yes The ticketId whose conversation thread to fetch (from superops_get_ticket_list).
superops_get_ticket_custom_field parameters
Param Type Required Default Description
inputJson string yes The ticket custom-field identifier as a raw JSON object string (per SuperOps docs, e.g. {"name":"<field name>"}).
superops_get_ticket_custom_field_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps search condition as a raw JSON object string (goes into ListInfoInput.condition).
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page, max 100 (default 50).
sortJson string no null Optional sort as a raw JSON array string (goes into ListInfoInput.sort).
superops_get_ticket_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps search condition as a raw JSON object string (goes into ListInfoInput.condition). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page, max 100 (default 50).
sortJson string no null Optional sort as a raw JSON array string (goes into ListInfoInput.sort). Omit for default order.
superops_get_ticket_note_list parameters
Param Type Required Default Description
ticketId string yes The ticketId whose internal notes to fetch (from superops_get_ticket_list).
superops_hard_delete_tickets parameters
Param Type Required Default Description
inputJson string yes A raw JSON array string of TicketIdentifierInput objects, e.g. [{"ticketId":"<id>"}].
superops_restore_tickets parameters
Param Type Required Default Description
inputJson string yes A raw JSON array string of TicketIdentifierInput objects, e.g. [{"ticketId":"<id>"}].
superops_soft_delete_tickets parameters
Param Type Required Default Description
inputJson string yes A raw JSON array string of TicketIdentifierInput objects, e.g. [{"ticketId":"<id>"}].
superops_update_ticket parameters
Param Type Required Default Description
clearFields string no null Optional comma-separated field names to explicitly clear/reset (emits JSON null for each). Omit to change nothing extra.
inputJson string yes The UpdateTicketInput as a raw JSON object string (must include ticketId and the fields to change).

Tasks & Worklogs

Tool Plan Access Description
superops_create_task Pro Write [SuperOps] Create a task. Supply the full CreateTaskInput as a raw JSON object string in inputJson (per SuperOps docs — typically the title, an owning ticket/project reference, and optional assignee/dueDate). All dates are UTC ISO-8601. Returns the new . Read it back with superops_get_task.
superops_create_worklog_entries Pro Write [SuperOps] Add one or more worklog (time) entries. Supply inputJson as a raw JSON ARRAY of worklog-entry input objects (per SuperOps docs — typically a ticket/task reference, technician, time spent, and notes). All dates/times are UTC ISO-8601. List entries with superops_get_worklog_entries; edit one with superops_update_worklog_entry.
superops_delete_worklog_entry Pro Destructive [SuperOps] Permanently delete a single worklog (time) entry. Supply the entry's identifier as a raw JSON object string in inputJson (per SuperOps docs — the worklog entry id). This is irreversible.
superops_get_task Free Read-only [SuperOps] Fetch a single task by its taskId (from superops_get_task_list). Returns the task's core fields (taskId, title, status). For additional fields (assignee, dueDate, ticket link) use superops_run_query with an expanded selection set. Create tasks with superops_create_task.
superops_get_task_list Free Read-only [SuperOps] List tasks (paginated). Offset pagination via page (1-based) and pageSize (max 100); optional conditionJson / sortJson raw-JSON filters go into ListInfoInput. Returns { tasks [...], listInfo { totalCount, hasMore } }; walk pages while listInfo.hasMore is true. Use a returned taskId with superops_get_task.
superops_get_work_status_list Free Read-only [SuperOps] List the configured work statuses (the timer/work states used on worklog entries), paginated. Offset pagination via page (1-based) and pageSize (max 100); optional conditionJson / sortJson raw-JSON filters go into ListInfoInput. Returns { workStatuses [...], listInfo { totalCount, hasMore } }.
superops_get_worklog_entries Free Read-only [SuperOps] List worklog (time) entries, paginated. Scope to a ticket or task by passing its id in conditionJson (a SuperOps search condition object, e.g. {"ticketId":"<id>"}); page/pageSize control offset pagination (pageSize max 100). Returns { worklogEntries [...], listInfo { totalCount, hasMore } }. Add entries with superops_create_worklog_entries.
superops_update_worklog_entry Pro Write [SuperOps] Update a single worklog (time) entry. Supply the UpdateWorklogEntryInput as a raw JSON object string in inputJson (must include the entry's id plus the fields to change). Only include fields you intend to change — an explicitly-null field CLEARS it; to blank fields intentionally list them in clearFields (comma-separated). Returns the updated .
superops_create_task parameters
Param Type Required Default Description
inputJson string yes The full CreateTaskInput as a raw JSON object string (per SuperOps docs).
superops_create_worklog_entries parameters
Param Type Required Default Description
inputJson string yes A raw JSON array string of worklog-entry input objects (per SuperOps docs).
superops_delete_worklog_entry parameters
Param Type Required Default Description
inputJson string yes The worklog-entry identifier as a raw JSON object string (per SuperOps docs).
superops_get_task parameters
Param Type Required Default Description
taskId string yes The taskId of the task to fetch (from superops_get_task_list).
superops_get_task_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps search condition as a raw JSON object string (goes into ListInfoInput.condition).
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page, max 100 (default 50).
sortJson string no null Optional sort as a raw JSON array string (goes into ListInfoInput.sort).
superops_get_work_status_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps search condition as a raw JSON object string (goes into ListInfoInput.condition).
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page, max 100 (default 50).
sortJson string no null Optional sort as a raw JSON array string (goes into ListInfoInput.sort).
superops_get_worklog_entries parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps search condition as a raw JSON object string scoping the entries (e.g. {"ticketId":"<id>"}). Goes into ListInfoInput.condition.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page, max 100 (default 50).
sortJson string no null Optional sort as a raw JSON array string (goes into ListInfoInput.sort).
superops_update_worklog_entry parameters
Param Type Required Default Description
clearFields string no null Optional comma-separated field names to explicitly clear/reset (emits JSON null for each).
inputJson string yes The UpdateWorklogEntryInput as a raw JSON object string (must include the entry id and the fields to change).

Fields

Tool Plan Access Description
superops_create_field Pro Write [SuperOps] Create a field definition. Supply the full CreateFieldInput as a raw JSON object string in inputJson (per SuperOps docs — typically the module, label, columnName, and fieldType). Returns the new field's . Inspect the module's existing fields first with superops_get_all_fields.
superops_delete_field Pro Destructive [SuperOps] Permanently delete a field definition. Supply the field identifier as a raw JSON object string in inputJson (per SuperOps docs — the field id). This is irreversible and removes the field (and its stored values) from the module.
superops_get_all_fields Free Read-only [SuperOps] Fetch all field definitions for a module. Pass module as the SuperOps module name (e.g. TICKET, COMPANY_USER). Returns each field's id, module, columnName, label, description, and fieldType. Use this to discover the columnName/fieldType before building conditionJson filters or update payloads for that module. For a single field use superops_get_field.
superops_get_field Free Read-only [SuperOps] Fetch a single field definition. Supply the field identifier as a raw JSON object string in inputJson (per SuperOps docs — typically the field id). Returns id, module, columnName, label, description, and fieldType. List field definitions with superops_get_fields or superops_get_all_fields.
superops_get_fields Free Read-only [SuperOps] Fetch one or more field definitions by their identifiers (the getFields(input: [FieldIdentifierInput!]!) batch read). Supply inputJson as a raw JSON ARRAY of FieldIdentifierInput objects (per SuperOps docs, e.g. [{"id":"<field id>"}]). Returns each field's id, module, columnName, label, description, and fieldType. To enumerate every field for one module in a single call use superops_get_all_fields; for a single field use superops_get_field.
superops_update_field Pro Write [SuperOps] Update a field definition. Supply the UpdateFieldInput as a raw JSON object string in inputJson (must include the field id plus the fields to change). Only include fields you intend to change — an explicitly-null field CLEARS it; to blank fields intentionally list them in clearFields (comma-separated). Returns the updated .
superops_create_field parameters
Param Type Required Default Description
inputJson string yes The full CreateFieldInput as a raw JSON object string (per SuperOps docs).
superops_delete_field parameters
Param Type Required Default Description
inputJson string yes The field identifier as a raw JSON object string (per SuperOps docs, e.g. {"id":"<field id>"}).
superops_get_all_fields parameters
Param Type Required Default Description
module string yes The SuperOps module name whose fields to fetch (e.g. TICKET, COMPANY_USER).
superops_get_field parameters
Param Type Required Default Description
inputJson string yes The field identifier as a raw JSON object string (per SuperOps docs, e.g. {"id":"<field id>"}).
superops_get_fields parameters
Param Type Required Default Description
inputJson string yes A raw JSON array string of FieldIdentifierInput objects (per SuperOps docs, e.g. [{"id":"<field id>"}]).
superops_update_field parameters
Param Type Required Default Description
clearFields string no null Optional comma-separated field names to explicitly clear/reset (emits JSON null for each).
inputJson string yes The UpdateFieldInput as a raw JSON object string (must include the field id and the fields to change).

Service Catalog

Tool Plan Access Description
superops_create_service_catalog_item Pro Write [SuperOps] Create a service catalog item. Provide the full item payload as a JSON object in `inputJson` (fields per the SuperOps createServiceCatalogItem input). Returns the raw GraphQL response.
superops_create_service_category Pro Write [SuperOps] Create a service category. Provide the full payload as a JSON object in `inputJson` (fields per the SuperOps createServiceCategory input). Returns the raw GraphQL response.
superops_create_service_item Pro Write [SuperOps] Create a service item. Provide the full item payload as a JSON object in `inputJson` (fields per the SuperOps createServiceItem input). Returns the raw GraphQL response.
superops_get_offered_items Free Read-only [SuperOps] List items offered to a client or contract (paginated). Scope to a client/contract by passing its identifier inside the `conditionJson` filter (the SuperOps search/pagination condition shape). Returns the raw GraphQL response for getOfferedItems; check listInfo.hasMore to page.
superops_get_service_catalog_item Free Read-only [SuperOps] Fetch a single service catalog item by ID. Discover IDs via superops_get_service_catalog_item_list. Returns the raw GraphQL response for getServiceCatalogItem.
superops_get_service_catalog_item_list Free Read-only [SuperOps] List service catalog items (paginated). Supply optional condition/sort as JSON to filter and order. Use superops_get_service_catalog_item for full detail on one item. Returns the raw GraphQL response for getServiceCatalogItemList; check listInfo.hasMore to page.
superops_get_service_category_list Free Read-only [SuperOps] List service categories (paginated). Supply optional condition/sort as JSON to filter and order. Returns the raw GraphQL response for getServiceCategoryList; check listInfo.hasMore to page.
superops_get_service_item Free Read-only [SuperOps] Fetch a single service item by ID. Discover IDs via superops_get_service_item_list. Returns the raw GraphQL response for getServiceItem.
superops_get_service_item_list Free Read-only [SuperOps] List service items (paginated). Supply optional condition/sort as JSON to filter and order. Use superops_get_service_item for full detail. Returns the raw GraphQL response for getServiceItemList; check listInfo.hasMore to page.
superops_update_service_catalog_item Pro Write [SuperOps] Update a service catalog item. Provide the changed fields (including the item id) as a JSON object in `inputJson`. IMPORTANT: sending a field as explicit null CLEARS it — to leave a field unchanged, OMIT it from inputJson. Use `clearFields` to intentionally clear/reset specific fields (they are sent as explicit JSON null). Returns the raw GraphQL response.
superops_create_service_catalog_item parameters
Param Type Required Default Description
inputJson string yes The service catalog item to create, as a JSON object matching the SuperOps createServiceCatalogItem input (e.g. name, description, price fields).
superops_create_service_category parameters
Param Type Required Default Description
inputJson string yes The service category to create, as a JSON object matching the SuperOps createServiceCategory input (e.g. name, description).
superops_create_service_item parameters
Param Type Required Default Description
inputJson string yes The service item to create, as a JSON object matching the SuperOps createServiceItem input.
superops_get_offered_items parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object — put the client/contract scope here (e.g. {"clientId":"..."}). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_service_catalog_item parameters
Param Type Required Default Description
id string yes The service catalog item ID (from superops_get_service_catalog_item_list).
superops_get_service_catalog_item_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object (search/pagination doc shape). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_service_category_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_service_item parameters
Param Type Required Default Description
id string yes The service item ID (from superops_get_service_item_list).
superops_get_service_item_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_update_service_catalog_item parameters
Param Type Required Default Description
clearFields array no null Optional field names to explicitly CLEAR (reset to null) on the item. Only include a field here if you intend to wipe its value.
inputJson string yes The fields to update (including the item id), as a JSON object matching the SuperOps updateServiceCatalogItem input. Omitted fields are left unchanged.

Financial

Tool Plan Access Description
superops_create_invoice Pro Write [SuperOps] Create an invoice. Provide the full invoice payload as a JSON object in `inputJson` (client, line items, dates, etc. per the SuperOps createInvoice input). Dates are UTC ISO-8601. Returns the raw GraphQL response.
superops_create_tax Pro Write [SuperOps] Create a tax definition. Provide the full payload as a JSON object in `inputJson` (name, rate, etc. per the SuperOps createTax input). Returns the raw GraphQL response.
superops_get_invoice Free Read-only [SuperOps] Fetch a single invoice by ID. Discover IDs via superops_get_invoice_list; list its line items with superops_get_invoice_item_list. Returns the raw GraphQL response for getInvoice.
superops_get_invoice_item_list Free Read-only [SuperOps] List the line items of an invoice (paginated). Scope to one invoice by passing its id inside the `conditionJson` filter (e.g. {"invoiceId":"..."}). Discover invoice IDs via superops_get_invoice_list. Returns the raw GraphQL response for getInvoiceItemList; check listInfo.hasMore to page.
superops_get_invoice_list Free Read-only [SuperOps] List invoices (paginated). Supply optional condition/sort as JSON to filter (e.g. by client or status) and order. Use superops_get_invoice for full detail. Returns the raw GraphQL response for getInvoiceList; check listInfo.hasMore to page.
superops_get_payment_method_list Free Read-only [SuperOps] List configured payment methods (paginated). Supply optional condition/sort as JSON. Returns the raw GraphQL response for getPaymentMethodList; check listInfo.hasMore to page.
superops_get_payment_term_list Free Read-only [SuperOps] List configured payment terms (paginated). Supply optional condition/sort as JSON. Returns the raw GraphQL response for getPaymentTermList; check listInfo.hasMore to page.
superops_get_tax Free Read-only [SuperOps] Fetch a single tax definition by ID. Discover IDs via superops_get_tax_list. Returns the raw GraphQL response for getTax.
superops_get_tax_list Free Read-only [SuperOps] List tax definitions (paginated). Supply optional condition/sort as JSON to filter and order. Use superops_get_tax for full detail. Returns the raw GraphQL response for getTaxList; check listInfo.hasMore to page.
superops_update_invoice Pro Write [SuperOps] Update an invoice. Provide the changed fields (including the invoice id) as a JSON object in `inputJson`. IMPORTANT: sending a field as explicit null CLEARS it — to leave a field unchanged, OMIT it. Use `clearFields` to intentionally clear/reset specific fields. Returns the raw GraphQL response.
superops_create_invoice parameters
Param Type Required Default Description
inputJson string yes The invoice to create, as a JSON object matching the SuperOps createInvoice input.
superops_create_tax parameters
Param Type Required Default Description
inputJson string yes The tax definition to create, as a JSON object matching the SuperOps createTax input.
superops_get_invoice parameters
Param Type Required Default Description
id string yes The invoice ID (from superops_get_invoice_list).
superops_get_invoice_item_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object — put the invoice scope here (e.g. {"invoiceId":"..."}). Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_invoice_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_payment_method_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_payment_term_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_tax parameters
Param Type Required Default Description
id string yes The tax definition ID (from superops_get_tax_list).
superops_get_tax_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_update_invoice parameters
Param Type Required Default Description
clearFields array no null Optional field names to explicitly CLEAR (reset to null) on the invoice. Only include a field here to wipe its value.
inputJson string yes The fields to update (including the invoice id), as a JSON object matching the SuperOps updateInvoice input. Omitted fields are left unchanged.

Knowledge Base

Tool Plan Access Description
superops_create_kb_article Pro Write [SuperOps] Create a knowledge base article. Provide the full payload as a JSON object in `inputJson` (title, content, collection, etc. per the SuperOps createKbArticle input). Returns the raw GraphQL response.
superops_create_kb_collection Pro Write [SuperOps] Create a knowledge base collection. Provide the full payload as a JSON object in `inputJson` (name, description, etc. per the SuperOps createKbCollection input). Returns the raw GraphQL response.
superops_delete_kb_article Pro Destructive [SuperOps] Permanently DELETE a knowledge base article by ID. This is irreversible. Discover article IDs via superops_get_kb_items. Returns the raw GraphQL response for deleteKbArticle.
superops_delete_kb_collection Pro Destructive [SuperOps] Permanently DELETE a knowledge base collection by ID. This is irreversible and may affect the articles it contains. Discover collection IDs via superops_get_kb_items. Returns the raw GraphQL response for deleteKbCollection.
superops_get_kb_item Free Read-only [SuperOps] Fetch a single knowledge base item (article or collection) by ID. Discover IDs via superops_get_kb_items. Returns the raw GraphQL response for getKbItem.
superops_get_kb_items Free Read-only [SuperOps] List knowledge base items — articles and collections (paginated). Supply optional condition/sort as JSON to filter and order. Use superops_get_kb_item for full detail. Returns the raw GraphQL response for getKbItems; check listInfo.hasMore to page.
superops_update_kb_article Pro Write [SuperOps] Update a knowledge base article. Provide the changed fields (including the article id) as a JSON object in `inputJson`. IMPORTANT: sending a field as explicit null CLEARS it — to leave a field unchanged, OMIT it. Use `clearFields` to intentionally clear/reset specific fields. Returns the raw GraphQL response.
superops_update_kb_collection Pro Write [SuperOps] Update a knowledge base collection. Provide the changed fields (including the collection id) as a JSON object in `inputJson`. IMPORTANT: sending a field as explicit null CLEARS it — to leave a field unchanged, OMIT it. Use `clearFields` to intentionally clear/reset specific fields. Returns the raw GraphQL response.
superops_create_kb_article parameters
Param Type Required Default Description
inputJson string yes The KB article to create, as a JSON object matching the SuperOps createKbArticle input.
superops_create_kb_collection parameters
Param Type Required Default Description
inputJson string yes The KB collection to create, as a JSON object matching the SuperOps createKbCollection input.
superops_delete_kb_article parameters
Param Type Required Default Description
id string yes The KB article ID to delete (from superops_get_kb_items).
superops_delete_kb_collection parameters
Param Type Required Default Description
id string yes The KB collection ID to delete (from superops_get_kb_items).
superops_get_kb_item parameters
Param Type Required Default Description
id string yes The KB item ID (from superops_get_kb_items).
superops_get_kb_items parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_update_kb_article parameters
Param Type Required Default Description
clearFields array no null Optional field names to explicitly CLEAR (reset to null) on the article. Only include a field here to wipe its value.
inputJson string yes The fields to update (including the article id), as a JSON object matching the SuperOps updateKbArticle input. Omitted fields are left unchanged.
superops_update_kb_collection parameters
Param Type Required Default Description
clearFields array no null Optional field names to explicitly CLEAR (reset to null) on the collection. Only include a field here to wipe its value.
inputJson string yes The fields to update (including the collection id), as a JSON object matching the SuperOps updateKbCollection input. Omitted fields are left unchanged.

IT Documentation

Tool Plan Access Description
superops_create_it_documentation Pro Write [SuperOps] Create an IT-documentation record. Provide the full payload as a JSON object in `inputJson` (title, content, client, category, etc. per the SuperOps createItDocumentation input). Returns the raw GraphQL response.
superops_delete_it_documentation Pro Destructive [SuperOps] Permanently DELETE an IT-documentation record by ID. This is irreversible. Discover record IDs via superops_get_it_documentation_list. Returns the raw GraphQL response for deleteItDocumentation.
superops_get_it_documentation Free Read-only [SuperOps] Fetch a single IT-documentation record by ID. Discover IDs via superops_get_it_documentation_list. Returns the raw GraphQL response for getItDocumentation.
superops_get_it_documentation_categories Free Read-only [SuperOps] List IT-documentation categories (paginated). Supply optional condition/sort as JSON. Returns the raw GraphQL response for getItDocumentationCategories; check listInfo.hasMore to page.
superops_get_it_documentation_list Free Read-only [SuperOps] List IT-documentation records (paginated). Supply optional condition/sort as JSON to filter (e.g. by client or category) and order. Use superops_get_it_documentation for full detail. Returns the raw GraphQL response for getItDocumentationList; check listInfo.hasMore to page.
superops_update_it_documentation Pro Write [SuperOps] Update an IT-documentation record. Provide the changed fields (including the record id) as a JSON object in `inputJson`. IMPORTANT: sending a field as explicit null CLEARS it — to leave a field unchanged, OMIT it. Use `clearFields` to intentionally clear/reset specific fields. Returns the raw GraphQL response.
superops_create_it_documentation parameters
Param Type Required Default Description
inputJson string yes The IT-documentation record to create, as a JSON object matching the SuperOps createItDocumentation input.
superops_delete_it_documentation parameters
Param Type Required Default Description
id string yes The IT-documentation record ID to delete (from superops_get_it_documentation_list).
superops_get_it_documentation parameters
Param Type Required Default Description
id string yes The IT-documentation record ID (from superops_get_it_documentation_list).
superops_get_it_documentation_categories parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_get_it_documentation_list parameters
Param Type Required Default Description
conditionJson string no null Optional SuperOps `condition` filter as a JSON object. Omit for no filter.
page integer no 1 1-based page number (default 1).
pageSize integer no 50 Items per page (default 50, capped at 100 by the API).
sortJson string no null Optional SuperOps `sort` order as a JSON array. Omit for default ordering.
superops_update_it_documentation parameters
Param Type Required Default Description
clearFields array no null Optional field names to explicitly CLEAR (reset to null) on the record. Only include a field here to wipe its value.
inputJson string yes The fields to update (including the record id), as a JSON object matching the SuperOps updateItDocumentation input. Omitted fields are left unchanged.

Ticket Reference Data

Tool Plan Access Description
superops_create_categories Pro Write [SuperOps] Create one or more ticket categories (batch). inputJson is a JSON ARRAY of CreateCategoryInput objects, e.g. [{"name":"Hardware"},{"name":"Network"}]. List existing categories with superops_get_category_list. Returns the raw SuperOps GraphQL JSON.
superops_create_causes Pro Write [SuperOps] Create one or more ticket cause values (batch). inputJson is a JSON ARRAY of CreateCauseInput objects, e.g. [{"name":"User error"}]. List existing causes with superops_get_cause_list. Returns the raw SuperOps GraphQL JSON.
superops_create_status Pro Write [SuperOps] Create a ticket status. inputJson is the CreateStatusInput object, e.g. {"name":"Awaiting Parts"}. List existing statuses with superops_get_status_list. Returns the raw SuperOps GraphQL JSON.
superops_get_category_list Free Read-only [SuperOps] List the account's ticket categories (paginated). Use the returned category values when creating/updating tickets or when defining categories via superops_create_categories.
superops_get_cause_list Free Read-only [SuperOps] List the account's ticket cause values (paginated). Reference data for ticket classification; create new causes via superops_create_causes.
superops_get_impact_list Free Read-only [SuperOps] List the account's ticket impact values (paginated). Reference data used with urgency to derive priority.
superops_get_priority_list Free Read-only [SuperOps] List the account's ticket priorities (paginated). Reference data for ticket triage.
superops_get_resolution_code_list Free Read-only [SuperOps] List the account's ticket resolution codes (paginated). Reference data for closing tickets with a standardized outcome.
superops_get_status_list Free Read-only [SuperOps] List the account's ticket statuses (paginated). Reference data for ticket state; create new statuses via superops_create_status.
superops_get_urgency_list Free Read-only [SuperOps] List the account's ticket urgency values (paginated). Reference data used with impact to derive priority.
superops_create_categories parameters
Param Type Required Default Description
inputJson string yes A JSON array of CreateCategoryInput objects, e.g. [{"name":"Hardware"}]. Confirm field names against your SuperOps schema.
superops_create_causes parameters
Param Type Required Default Description
inputJson string yes A JSON array of CreateCauseInput objects, e.g. [{"name":"User error"}]. Confirm field names against your SuperOps schema.
superops_create_status parameters
Param Type Required Default Description
inputJson string yes The CreateStatusInput object as a JSON string, e.g. {"name":"Awaiting Parts"}. Confirm field names against your SuperOps schema.
superops_get_category_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_cause_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_impact_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_priority_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_resolution_code_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_status_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_urgency_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.

Technicians & Teams

Tool Plan Access Description
superops_create_technician Pro Write [SuperOps] Create a technician (internal MSP user). inputJson is the CreateTechnicianInput object, e.g. {"name":"Jane Doe","email":"jane@msp.com","roleId":"..."}. Discover role ids with superops_get_technician_role_list and teams with superops_get_team_list. Returns the raw SuperOps GraphQL JSON.
superops_delete_technician Pro Destructive [SuperOps] Delete a technician (internal MSP user). DESTRUCTIVE — the technician is removed and any assignments to them are affected. Provide the technician id (from superops_get_technician_list).
superops_get_business_function_list Free Read-only [SuperOps] List business functions configured on the account (paginated). Reference data used to categorize technicians/teams by business area.
superops_get_designation_list Free Read-only [SuperOps] List technician designations (job titles) configured on the account (paginated). Reference data for technician records.
superops_get_requester_role_list Free Read-only [SuperOps] List requester roles (permission profiles for client-side users) on the account (paginated).
superops_get_team_list Free Read-only [SuperOps] List technician teams on the account (paginated). Teams group technicians for assignment and reporting.
superops_get_technician_group_list Free Read-only [SuperOps] List technician groups on the account (paginated). Reference data for grouping technicians.
superops_get_technician_list Free Read-only [SuperOps] List technicians (internal MSP users) on the account (paginated). This is also StackJack's connection-validation probe. Manage technicians via superops_create_technician / superops_update_technician / superops_delete_technician.
superops_get_technician_role_list Free Read-only [SuperOps] List technician roles (permission profiles for internal users) on the account (paginated).
superops_update_technician Pro Write [SuperOps] Update a technician (internal MSP user). inputJson is the UpdateTechnicianInput object and MUST carry the technician's id plus the fields to change. To CLEAR a field, list its name in clearFields (emitted as explicit null); omit fields you want left unchanged. Returns the raw SuperOps GraphQL JSON.
superops_create_technician parameters
Param Type Required Default Description
inputJson string yes The CreateTechnicianInput object as a JSON string, e.g. {"name":"Jane Doe","email":"jane@msp.com"}. Confirm field names against your SuperOps schema.
superops_delete_technician parameters
Param Type Required Default Description
technicianId string yes The technician id to delete (from superops_get_technician_list).
superops_get_business_function_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_designation_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_requester_role_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_team_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_technician_group_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_technician_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_technician_role_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_update_technician parameters
Param Type Required Default Description
clearFields array no null Field names to CLEAR (reset to null) on the technician. Only include a field here if you intend to wipe its value. Omit or empty for none.
inputJson string yes The UpdateTechnicianInput object as a JSON string (must include the technician id + changed fields).

Business Setup

Tool Plan Access Description
superops_get_device_categories Free Read-only [SuperOps] List RMM device categories configured on the account. Reference data for classifying assets; assign a category to an asset via superops_assign_device_category. Returns a flat array (no pagination).
superops_get_holiday_list Free Read-only [SuperOps] List the account's holiday calendar entries (paginated). Holidays feed business-hours and SLA calculations.
superops_get_sla_list Free Read-only [SuperOps] List SLA (service-level agreement) definitions on the account (paginated). SLAs drive ticket response/resolution targets.
superops_get_holiday_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.
superops_get_sla_list parameters
Param Type Required Default Description
page integer no null 1-based page number. Defaults to 1.
pageSize integer no null Items per page (max 100). Defaults to 50.

GraphQL Passthrough

Tool Plan Access Description
superops_run_mutation Pro Destructive [SuperOps] Run an ARBITRARY GraphQL mutation document against the SuperOps /msp endpoint and return the raw JSON body verbatim. ESCAPE HATCH: this bypasses per-tool gating and is DESTRUCTIVE — it can create, change, or delete anything the token can reach. Prefer a discrete superops_* tool when one exists. Provide the full GraphQL document in `mutation`; pass any variables as a JSON object in `variablesJson`. On updates, an explicit JSON null CLEARS a field; omit fields to leave them unchanged. GraphQL returns 200 with a top-level errors[] on failure — inspect errors[], not the HTTP status.
superops_run_query Pro Destructive [SuperOps] Run an ARBITRARY GraphQL query document against the SuperOps /msp endpoint and return the raw JSON body verbatim. ESCAPE HATCH: this bypasses per-tool gating and is flagged destructive because an arbitrary document can carry a mutation — prefer a discrete superops_* tool when one exists. Provide the full GraphQL document in `query`; pass any variables as a JSON object in `variablesJson`. GraphQL returns 200 with a top-level errors[] on failure — inspect errors[], not the HTTP status.
superops_run_mutation parameters
Param Type Required Default Description
mutation string yes The complete GraphQL mutation document, e.g. "mutation($input: CreateStatusInput!){ createStatus(input:$input) }".
variablesJson string no null Optional GraphQL variables as a JSON object, e.g. {"input":{"name":"Awaiting Parts"}}. Omit if the document takes no variables.
superops_run_query parameters
Param Type Required Default Description
query string yes The complete GraphQL query document, e.g. "query($input: ListInfoInput!){ getTechnicianList(input:$input){ technicians listInfo } }".
variablesJson string no null Optional GraphQL variables as a JSON object, e.g. {"input":{"page":1,"pageSize":10}}. Omit if the document takes no variables.