Open App

Categories

CLI commands for categories

categories list

monoid categories list [options]

List categories

Options

FlagDescriptionDefault
--limit <n>Max results
--offset <n>Skip n results
--entity-type <value>Filter by entityType
--organisation-id <value>Filter by organisationId

Example

monoid categories list [options]

Example output

{
  "data": [
    {
      "_id": "abc123",
      "name": "Example item",
      "updatedAt": 1760000000000
    }
  ]
}

categories get

monoid categories get <id>

Get category by id

Arguments

NameRequiredDescription
idYes

Example

monoid categories get <id>

Example output

{
  "data": {
    "_id": "abc123",
    "updatedAt": 1760000000000
  }
}

categories create

monoid categories create [options]

Create category

Options

FlagDescriptionDefault
--body <json>Request body JSON (merged with flags)
--name <value>name
--color <value>color
--entity-type <value>entityType
--organisation-id <value>organisationId

Example

monoid categories create [options]

Example output

{
  "data": {
    "_id": "abc123",
    "updatedAt": 1760000000000
  }
}

categories update

monoid categories update [options] <id>

Update category

Arguments

NameRequiredDescription
idYes

Options

FlagDescriptionDefault
--body <json>Request body JSON (merged with flags)
--ids <ids>Comma-separated IDs for bulk update (max 25)
--name <value>name
--color <value>color
--entity-type <value>entityType
--organisation-id <value>organisationId

Example

monoid categories update [options] <id>

Example output

{
  "data": {
    "_id": "abc123",
    "updatedAt": 1760000000000
  }
}

categories delete

monoid categories delete [options] <id>

Delete category

Arguments

NameRequiredDescription
idYes

Options

FlagDescriptionDefault
--ids <ids>Comma-separated IDs for bulk delete (max 25)

Example

monoid categories delete [options] <id>

Example output

{
  "data": null,
  "deleted": true
}

See Categories API reference for HTTP endpoint details.