Plugin Registry

List all plugins with optional search and filtering

GET

http://localhost:3000/api/plugins

Retrieve a paginated list of plugins with optional filtering and search capabilities. Use query parameters for search, category, status, type filtering.

curl -X GET 'http://localhost:3000/api/plugins'

const response = await fetch('http://localhost:3000/api/plugins', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('http://localhost:3000/api/plugins')
print(response.text)

200

[
  {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": false,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "name": "string",
    "description": "string",
    "type": "DESKTOP",
    "status": "ACTIVE",
    "categoryId": "string",
    "category": {},
    "versions": [
      "string"
    ],
    "author": "string",
    "license": "string",
    "homepage": "string",
    "repository": "string",
    "uploadedBy": {
      "deletedAt": "2018-11-21T06:20:32.232Z",
      "createdAt": "2018-11-21T06:20:32.232Z",
      "updatedAt": "2018-11-21T06:20:32.232Z",
      "id": "string",
      "isActive": true,
      "isArchived": false,
      "archivedAt": "2018-11-21T06:20:32.232Z",
      "tenantId": "string",
      "thirdPartyId": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "username": "string",
      "timeZone": "string",
      "timeFormat": 12,
      "hash": "string",
      "refreshToken": "string",
      "imageUrl": "string",
      "preferredLanguage": "en",
      "preferredComponentLayout": "CARDS_GRID",
      "uiPreferences": {},
      "code": "string",
      "codeExpireAt": "2024-01-15T09:30:00Z",
      "emailVerifiedAt": "2024-01-15T09:30:00Z",
      "lastLoginAt": "2024-01-15T09:30:00Z",
      "emailToken": "string",
      "roleId": "string",
      "imageId": "string",
      "defaultTeamId": "string",
      "lastTeamId": "string",
      "defaultOrganizationId": "string",
      "lastOrganizationId": "string"
    },
    "uploadedAt": "2024-01-15T09:30:00Z",
    "requiresSubscription": false,
    "isFeatured": false,
    "isVerified": false,
    "lastDownloadedAt": "2024-01-15T09:30:00Z",
    "pluginTenants": [
      "string"
    ],
    "settings": [
      "string"
    ],
    "subscriptions": [
      "string"
    ],
    "subscriptionPlans": [
      "string"
    ],
    "pluginTags": [
      "string"
    ]
  }
]

Parameters

selectObjectquery

relationsObjectquery

whereObjectquery

orderObjectquery

withDeletedbooleanquery

takenumber[0, 100]query

skipnumber>= 0query

searchstringquery

Search text to filter plugins by name, description, or author

namestringquery

Filter by plugin name (exact match)

descriptionstringquery

Filter by plugin description (partial match)

typestringDESKTOPWEBMOBILEquery

Filter by plugin type

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDquery

Filter by plugin status

isActivebooleanquery

Filter by active state

categoryIdstringquery

Filter by plugin category ID

authorstringquery

Filter by plugin author

licensestringquery

Filter by plugin license

uploadedByIdstringquery

Filter by user who uploaded the plugin

uploadedAfterstring<date-time>query

Filter plugins uploaded after this date

uploadedBeforestring<date-time>query

Filter plugins uploaded before this date

downloadedAfterstring<date-time>query

Filter plugins downloaded after this date

downloadedBeforestring<date-time>query

Filter plugins downloaded before this date

minDownloadsnumber>= 0query

Filter by minimum download count

maxDownloadsnumber>= 0query

Filter by maximum download count

versionstringquery

Filter by version number

tagsArray<string>query

Filter by plugin tags

hasInstallationsbooleanquery

Include only plugins with installations

isVerifiedbooleanquery

Include only verified plugins

pagenumber>= 1query

Page number for pagination

limitnumber[1, 100]query

Number of items per page

sortBystringnameauthoruploadedAtlastDownloadedAtdownloadCountcreatedAtupdatedAtquery

Sort field

sortDirectionstringASCDESCquery

Sort direction

Response

200OKArray<Plugin_1>

List of plugins retrieved successfully.

Response fields application/json

Array<Plugin_1>

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleanfalse

Plugin is active or not

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

namestringrequired

Plugin name

descriptionstring

Plugin description

typestringDESKTOPWEBMOBILErequired

Type of the plugin

statusstringACTIVEINACTIVEDEPRECATEDARCHIVEDrequired

Status of the plugin

categoryIdstring

Plugin category ID

categoryobject

Plugin category

versionsArray<string>required

Versions of the plugin

authorstring

Plugin author

licensestring

Plugin license

homepagestring

Homepage URL

repositorystring

Repository URL

uploadedByUser

User who uploaded the plugin

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

thirdPartyIdstring

firstNamestring

lastNamestring

emailstring

phoneNumberstring

usernamestring

timeZonestring

timeFormatstring1224

hashstring

refreshTokenstring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

preferredComponentLayoutstringCARDS_GRIDTABLE

uiPreferencesobject

codestring

codeExpireAtstring<date-time>

emailVerifiedAtstring<date-time>

lastLoginAtstring<date-time>

emailTokenstring

roleIdstring

imageIdstring

defaultTeamIdstring

lastTeamIdstring

defaultOrganizationIdstring

lastOrganizationIdstring

uploadedAtstring<date-time>

Upload date

requiresSubscriptionbooleanfalserequired

Is subscription plan enabled

isFeaturedbooleanfalserequired

Whether the plugin is featured

isVerifiedbooleanfalserequired

Whether the plugin is verified by Gauzy

lastDownloadedAtstring<date-time>

Last downloaded date

pluginTenantsArray<string>

Plugin tenants for this plugin

settingsArray<string>

Plugin settings

subscriptionsArray<string>

Plugin subscriptions

subscriptionPlansArray<string>

Plugin subscription plans

pluginTagsArray<string>

Plugin tag relationships

400Bad Request

Invalid search or filter criteria provided.

401Unauthorized

Unauthorized access.

404Not Found

No plugins found matching the provided criteria.

Stack Overflow Website Demo