> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons/plugin.md).

# Plugin

Software modules that change how API calls behave, and which of them an account may use.

A plugin is a software module that changes how an API call behaves. Registering a tracker and generating a report both run through one: the plugin decides what extra parameters the call takes and what it does with them.

Which plugins an account may use varies, depending on platform settings and purchased features, and only those can be named in a call. This operation is how an integration finds out which it has.

## Plugin object

## The Plugin object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"Plugin":{"type":"object","description":"A software module that changes how certain API calls behave, such as which tracker registration flows or report types are available.","properties":{"id":{"type":"integer","description":"ID of the plugin."},"type":{"type":"string","description":"Plugin type, such as `tracker_register` or `tracker_report`."},"ui_module":{"type":"string","description":"Name of the plugin's UI module."},"module":{"type":"string","description":"Name of the plugin module."},"filter":{"type":"object","description":"Which device models this plugin applies to.","properties":{"exclusion":{"type":"boolean","description":"When `true`, `values` lists the models **not** supported. When `false`, it lists the only ones supported."},"values":{"type":"array","description":"Regular expressions matching device model names.","items":{"type":"string"}}}},"parameters":{"type":"object","description":"Plugin-specific parameters. **Omitted when null**, which it usually is.","additionalProperties":true}}}}}}
```

The report plugins have their own page, [report plugins](/docs/navixy-api/user-api/resources/commons/plugin/report_plugins.md), which documents the parameters each one takes.

## API actions

API base path: `/plugin`.

Operations that list no errors of their own return only the [general error codes](/docs/navixy-api/general/errors.md#error-codes).

***

## List plugins

> List the plugins available to the current user.\
> \
> Plugins are software modules that change how various API calls behave. Which ones are available varies by user, depending on platform settings and purchased features, and only these can be used to register trackers, generate reports and so on.\
> \
> Callable with an empty body. Also accepts GET.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Account and platform","description":"Platform-level resources shared across the account, such as the plugins that change how other calls behave."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"Plugin":{"type":"object","description":"A software module that changes how certain API calls behave, such as which tracker registration flows or report types are available.","properties":{"id":{"type":"integer","description":"ID of the plugin."},"type":{"type":"string","description":"Plugin type, such as `tracker_register` or `tracker_report`."},"ui_module":{"type":"string","description":"Name of the plugin's UI module."},"module":{"type":"string","description":"Name of the plugin module."},"filter":{"type":"object","description":"Which device models this plugin applies to.","properties":{"exclusion":{"type":"boolean","description":"When `true`, `values` lists the models **not** supported. When `false`, it lists the only ones supported."},"values":{"type":"array","description":"Regular expressions matching device model names.","items":{"type":"string"}}}},"parameters":{"type":"object","description":"Plugin-specific parameters. **Omitted when null**, which it usually is.","additionalProperties":true}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/plugin/list":{"post":{"tags":["Account and platform"],"summary":"List plugins","description":"List the plugins available to the current user.\n\nPlugins are software modules that change how various API calls behave. Which ones are available varies by user, depending on platform settings and purchased features, and only these can be used to register trackers, generate reports and so on.\n\nCallable with an empty body. Also accepts GET.","operationId":"pluginList","responses":{"200":{"description":"The available plugins","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"$ref":"#/components/schemas/Plugin"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Standalone-specific

When neither the user nor their dealer has any plugin enabled, the defaults apply instead, set by the `plugin.tracker.register.defaultIds` and `plugin.tracker.report.defaultIds` configuration options.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/commons/plugin.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.