Plugins

getPlugins

Get plugins list

GET /v2/plugins

Headers

KeyValueRequiredDescription
AuthorizationBearer {token}yesJWT Token of user

Response 200

KeyDescription
IDID of plugin
NameName of plugin
TypeType of plugin: Free, Premium
DescriptionDescription of plugin
LogoLogo of plugin
Background ImageBackground image of plugin
URLURL of plugin
AbilitiesAbilities of plugin
Created AtCreated at date
Updated AtUpdated at date
UserUser of plugin. If plugin is not installed user will be empty
{
  "status": 200,
  "success": true,
  "data": [
    {
      "id": 1,
      "name": "Name",
      "type": "Free",
      "description": "Description",
      "logo": "https://example.com/logo.png",
      "background_image": "https://example.com/background.png",
      "url": "https://plugin.com",
      "abilities": "[\"create-lead\",\"update-lead\",\"delete-lead\"]",
      "created_at": "2024-06-10T09:05:51.000000Z",
      "updated_at": "2024-06-10T09:05:52.000000Z",
      "user": {
        "id": 1,
        "plugin_id": 1,
        "user_id": 9,
        "token": "1|jCr5Qbg8IjimhZjL0mbTWSeWuvIw6a0Dy59KdmWad7e5b391",
        "created_at": "2024-06-10T09:13:49.000000Z",
        "updated_at": "2024-06-10T09:13:49.000000Z"
      }
    }
  ]
}

installPlugin

Install a plugin

POST /v2/plugins/install

Requires authorization

Body

KeyValueRequiredDescription
plugin_id{int}yesID of the plugin

Response 200

KeyDescription
Plugin IDID of plugin
User IDID of user
TokenToken of plugin
{
  "status": 200,
  "success": true,
  "data": {
    "plugin_id": 1,
    "user_id": 9,
    "token": "1|jCr5Qbg8IjimhZjL0mbTWSeWuvIw6a0Dy59KdmWad7e5b391",
    "updated_at": "2024-06-10T09:13:49.000000Z",
    "created_at": "2024-06-10T09:13:49.000000Z",
    "id": 1
  }
}