---
title: "Gets a list of all Plugin resources"
method: GET
path: "/api/v1/plugins/"
tags: ["Plugins"]
---

# Gets a list of all Plugin resources

`GET /api/v1/plugins/`

## Query parameters

- `sortBy` string
- `descending` boolean
- `search` string
- `groupId` integer
- `index` integer
- `pageLength` integer

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- PluginPage
  - `index` integer — Starting index of the current page.
  - `isComplete` boolean — Boolean indicating if more data is available.
  - `totalNumResults` integer — Total number of results.
  - `first` string — URL to first page in results set.
  - `next` string — URL to next page in results set.
  - `prev` string — URL to last page in results set.
  - `data` PluginDump[]
    - `id` integer — ID for the Plugin resource.
    - `snapshot` integer — ID for the underlying Plugin snapshot.
    - `group` GroupRef
      - `id` integer — ID for the Group resource.
      - `name` string — Name of the Group resource.
      - `url` string — URL for accessing the full Group resource.
    - `user` UserRefDump
      - `id` integer — ID for the User resource.
      - `username` string — Username of the User resource.
      - `url` string — URL for accessing the full User resource.
    - `createdOn` string, date-time — Timestamp when the Plugin resource was created.
    - `snapshotCreatedOn` string, date-time — Timestamp when the Plugin resource snapshot was created.
    - `lastModifiedOn` string, date-time — Timestamp when the Plugin resource was last modified.
    - `latestSnapshot` boolean — Whether or not the Plugin resource is the latest version.
    - `hasDraft` boolean — Whether a draft exists for the Plugin resource.
    - `tags` TagRefDump[]
      - `id` integer — ID for the Tag.
      - `name` string — Name of the Tag.
      - `group` GroupRef
        - `id` integer — ID for the Group resource.
        - `name` string — Name of the Group resource.
        - `url` string — URL for accessing the full Group resource.
      - `url` string — URL for accessing the full Tag.
    - `name` string, required — Name of the Plugin resource.
    - `description` string — Description of the Plugin resource.
    - `files` PluginFileRef[]
      - `id` integer — ID for the PluginFile resource.
      - `group` GroupRef
        - `id` integer — ID for the Group resource.
        - `name` string — Name of the Group resource.
        - `url` string — URL for accessing the full Group resource.
      - `url` string — URL for accessing the full PluginFile resource.
      - `plugin` integer — ID for the Plugin resource this file belongs to.
      - `filename` string — Filename of the PluginFile resource.
      - `tasks` PluginTaskContainer
        - `functions` FunctionTaskDump[]
          - `id` integer — Id of the PluginTask.
          - `name` string, required — Name of the PluginTask.
          - `inputParams` PluginTaskInputParameterDump[]
            - `name` string, required — Name of the PluginTaskParameter.
            - `parameterType` PluginParameterTypeRef
              - …
            - `required` boolean — Sets whether the input parameter is required (True) or optional (False). If True, then this parameter must be assigned a value in order to execute the PluginTask.
          - `outputParams` PluginTaskOutputParameterDump[]
            - `name` string, required — Name of the PluginTaskParameter.
            - `parameterType` PluginParameterTypeRef
              - …
        - `artifacts` ArtifactTaskDump[]
          - `id` integer — Id of the PluginTask.
          - `name` string, required — Name of the PluginTask.
          - `outputParams` PluginTaskOutputParameterDump[]
            - `name` string, required — Name of the PluginTaskParameter.
            - `parameterType` PluginParameterTypeRef
              - …

---

[API](https://skmtc.net/usnistgov/apis/dioptra-rest-api.md) · [All operations](https://skmtc.net/usnistgov/apis/dioptra-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usnistgov/dioptra-rest-api/versions/a73101579c5c/schema)