Plugin Registry

Get plugin by ID

GET

http://localhost:3000/api/plugins/{id}

Retrieves detailed information about a specific plugin by its UUID.

Get plugin by ID

curl -X GET 'http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000?withDeleted=false&loadEagerRelations=false'

const response = await fetch('http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000?withDeleted=false&loadEagerRelations=false', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('http://localhost:3000/api/plugins/550e8400-e29b-41d4-a716-446655440000?withDeleted=false&loadEagerRelations=false')
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

idstring<uuid>requiredpath

UUID of the plugin to retrieve

whereObjectquery

Conditions to find a specific plugin

relationsArray<string>query

Entity relations to include in the response

selectArray<string>query

Fields to select from the plugin entity

orderObjectquery

Order by fields

withDeletedbooleanfalsequery

Include soft deleted records

loadEagerRelationsbooleanfalsequery

Load eager relations automatically

Response

200OKPlugin_1

Plugin retrieved successfully.

Response fields application/json

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 input provided. Check the response body for error details.

401Unauthorized

Unauthorized access.

404Not Found

Plugin record not found.

Stack Overflow Website Demo