The plugin object

⚠️

Preview — this feature is being built; the design below is the spec.

The plugin object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "plg_01JCN1P3R5T7V9X1Z3B5",
  "type": "plugin",
  "name": "acme-review-rules",
  "display_name": "Acme code review rules",
  "source": {
    "kind": "upload"
  },
  "latest_version": "1.4.0",
  "policy": "required",
  "workspace_ids": null,
  "description": "House style checks and the /review command for Syntic Code.",
  "created_at": "2026-09-12T10:00:00Z",
  "updated_at": "2026-11-02T10:00:00Z"
}

Fields

Field	Type	Description
`id`	string	Starts with `plg_`.
`type`	string	The object type, always `plugin`.
`name`	string	Name shown in the Console and in reports.
`display_name`	string	See the endpoint pages below.
`source`	object	`upload` for bundles sent to this API, or `marketplace` with the `marketplace_id` it came from.
`latest_version`	string	Semantic version members receive.
`policy`	string	`required` (installed for everyone and cannot be turned off), `available` (members may install it), or `blocked` (cannot be installed, even from a marketplace).
`workspace_ids`	array or null	Limit the policy to members of these workspaces; `null` means the whole organization.
`description`	string	Free-text description.
`created_at`	string	When it was created, RFC 3339 UTC (some older objects use Unix seconds).
`updated_at`	string	When it last changed.

Returned by

organization plugin_marketplace

Was this page helpful?