Skip to main content
GET
/
api
/
spaces
/
coworkers
/
commands
{
  "Key": "<string>",
  "Name": "<string>",
  "AppliesOnlyToMultipleEntities": true,
  "AppliesOnlyToOneEntity": true,
  "NeedsEntitiesToRun": true,
  "Order": 123,
  "RequiresParameters": [
    {}
  ]
}
Commands are actions that can be executed on one or more Coworker records. Use this endpoint to discover which commands are available, then execute them via the Run command endpoint.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Coworker-List role.

​
Query Parameters

​
id
integer
If provided, only commands available for this specific Coworker will be returned.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkers/commands" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

Returns an array of available commands.
​
Key
string
Unique identifier for the command. Pass this to the Run command endpoint.
​
Name
string
Human-readable name of the command.
​
AppliesOnlyToMultipleEntities
boolean
Whether the command can only be run on multiple records at once.
​
AppliesOnlyToOneEntity
boolean
Whether the command can only be run on a single record.
​
NeedsEntitiesToRun
boolean
Whether the command requires record Ids to execute.
​
Order
integer
Display order for the command.
​
RequiresParameters
object[]
List of parameters required by this command, each containing Name and Type.
Example Response
[
  {
    "Key": "COMMAND_KEY_1",
    "Name": "Command name",
    "AppliesOnlyToMultipleEntities": false,
    "DisplayInDropdown": false,
    "DisplayInDropdownV2": true,
    "AppliesOnlyToOneEntity": true,
    "AppliesOnlyToTwoEntities": false,
    "DisplayInGrid": false,
    "Icon": "/Content/Themes/Admin/Images/Icons/Fugue/gear.png",
    "NeedsEntitiesToRun": true,
    "Order": 8,
    "RequiresParameters": [
      {
        "Name": "Parameter name",
        "Type": "parameterType"
      }
    ]
  }
]