---
title: "Command Search"
method: GET
path: "/command"
tags: ["command"]
---

# Command Search

`GET /command`

Search this users Commands

## Query parameters

- `commandId` integer
- `command` string
- `code` string
- `useRegexForName` integer
- `useRegexForCode` integer
- `logicalOperatorName` string
- `logicalOperatorCode` string
- `type` string
- `sortBy` 'commandId' | 'command' | 'code' | 'description' | 'availableOn' | 'createAlertOn' | 'groupsWithPermissions'
- `sortDir` 'asc' | 'desc'

## Response `200`

successful operation

- Command[]
  - `commandId` integer — Command Id
  - `command` string — Command Name
  - `code` string — Unique Code
  - `description` string — Description
  - `userId` integer — User Id
  - `commandString` string — Command String
  - `validationString` string — Validation String
  - `displayProfileId` integer — DisplayProfileId if specific to a Display Profile
  - `commandStringDisplayProfile` string — Command String specific to the provided DisplayProfile
  - `validationStringDisplayProfile` string — Validation String specific to the provided DisplayProfile
  - `availableOn` string — A comma separated list of player types this command is available on
  - `createAlertOn` string — Define if execution of this command should create an alert on success, failure, always or never.
  - `createAlertOnDisplayProfile` unknown
  - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this Command

## Changes

- **2026-08-20** `9136e3c2cb1d` — 2 info
  - added the new enum value `availableOn` to the `query` request parameter `sortBy`
  - added the new enum value `createAlertOn` to the `query` request parameter `sortBy`
- **2026-07-30** `fe497e811c7f` — 3 info
  - added the new optional `query` request parameter `sortBy`
  - added the new optional `query` request parameter `sortDir`
  - added the new optional `query` request parameter `type`
- **2026-02-25** `41c04de98ec5` — 1 info
  - added the media type `application/json` for the response with the status `200`
- **2025-01-30** `02a47f5c6345` — 1 info
  - endpoint added
- **2024-03-08** `7a6678dd43b4` — 1 breaking
  - api removed without deprecation

[Full history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/command/get.md)

---

[API](https://skmtc.dev/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.dev/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/9136e3c2cb1d/schema)