Get App List

This endpoint provides detailed information about a specific workflow application within your organisation, including its metadata, supported events, and associated company details. It enables organisations to explore the app's functionality, understand its actions and triggers, and integrate it with external services efficiently. By accessing this endpoint, organisations gain insights, streamlined management, and improved workflow optimisation through the utilisation of the app's capabilities.

Syntax: see 'CCall Structure

Type = 'GET'

'https://connect.cambrionix.com/api/workflows/v1/apps/'

Returns:

{ "result": [ { "created": { "time": time }, "updated": { "time": time }, "id": "app-id", "name": "app-name", "description": "app-description", "company": { "id": "company-id", "name": "company-name", "logo": "company-logo" }, "events": [ { "id": "event-id", "name": "event-name", "description": "event-description", "type": "event-type", "app": { "id": "app-id" }, "schema": { "options": { "type": "schema-type", "properties": {}, "default": {} }, "output": { "type": "schema-type", "properties": { "success": { "type": "schema-type", "default": true } }, "default": {} } } } ] } } }

Output	Description
time	The hub time, shown as an integer in ms
app-id	This is the id of the app as a unique 128-bit number
app-name	This is the name of the app
app-description	This is a description of the app
company-id	This is the id of the app creator as a unique 128-bit number
company-name	This is the name of the app creator
company-logo	This is the URL of the logo for the app creator
event-id	This is the id of the event as a unique 128-bit number
event-name	This is the name of the event
event-description	This is a description of the event
event-type	This is the type of event see Event Types
schema-type	This is the type of Schema for the event see Schema Types

Example

curl -X 'GET' \
  'https://connect.cambrionix.com/api/workflows/v1/apps' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6ImY2ZjZlNzc1L'
                                                    

Returns

{
  "result": [
    {
      "created": {
        "time": 1717511925383
      },
      "updated": {
        "time": 1731663028401
      },
      "id": "00000000-0000-0000-0000-000000000001",
      "name": "Hub API",
      "description": "Events for interacting with the Cambrionix Hub API.",
      "company": {
        "id": "00000000-0000-0000-0000-000000000001",
        "name": "Cambrionix",
        "logo": "https://cambrionix.wpenginepowered.com/wp-content/uploads/2020/12/cambrionix_logo_cmyk_white.svg"
      },
      "events": [
        {
          "id": "00000000-0000-0000-0000-000000000005",
          "name": "Switch All Ports Off",
          "description": "Switches all ports off on all hubs.",
          "type": "action",
          "app": {
            "id": "00000000-0000-0000-0000-000000000001"
          },
          "schema": {
            "options": {
              "type": "object",
              "properties": {},
              "default": {}
            },
            "output": {
              "type": "object",
              "properties": {
                "success": {
                  "type": "boolean",
                  "default": true
                }
              },
              "default": {}
            }
          }
        }
      ]
    }
  ]
}
                                                    

Errors

If there is an error in the API method then JSON-RPC Error Object a will be returned