Saltar al contenido principal
GET
/
v1
/
workflow
/
piece
List available pieces
import requests

url = "https://api.diga.io/v1/workflow/piece"

response = requests.get(url)

print(response.text)
[
  {
    "id": "<string>",
    "name": "<string>",
    "displayName": "<string>",
    "logoUrl": "<string>",
    "description": "<string>",
    "version": "<string>",
    "authors": [
      "<string>"
    ],
    "categories": [],
    "auth": {
      "type": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "required": true,
      "props": {},
      "authUrl": "<string>",
      "tokenUrl": "<string>",
      "scope": [
        "<string>"
      ],
      "username": {},
      "password": {}
    },
    "actions": 123,
    "triggers": 123,
    "suggestedActions": [
      {}
    ],
    "suggestedTriggers": [
      {}
    ],
    "projectUsage": 123,
    "platformId": "<string>",
    "archiveId": "<string>",
    "minimumSupportedRelease": "<string>",
    "maximumSupportedRelease": "<string>",
    "tags": [
      "<string>"
    ],
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z"
  }
]

Parámetros de consulta

​
search
string | null
​
suggestion_type
enum<string> | null

Filter pieces by what they offer.

Opciones disponibles:
ACTION,
TRIGGER,
ACTION_AND_TRIGGER
​
categories
enum<string>[] | null

Filter pieces by one or more categories. Repeat the param to pass multiple values, e.g. ?categories=MARKETING&categories=SALES_AND_CRM.

Diga's grouped piece categories. Each value collapses one or more upstream Activepieces categories — see _AP_TO_DIGA_CATEGORY in api/v1/routes/workflows/pieces.py for the mapping.

Opciones disponibles:
AI,
COMMUNICATION,
SALES_AND_CRM,
MARKETING,
PRODUCTIVITY,
COMMERCE,
DEVELOPMENT

Respuesta

Successful Response

​
id
string | null

Unique piece ID

​
name
string | null

Package name, e.g. "@activepieces/piece-slack"

​
displayName
string | null
​
logoUrl
string | null
​
description
string | null
​
version
string | null
​
authors
string[] | null
​
categories
enum<string>[] | null

Diga's grouped piece categories. Each value collapses one or more upstream Activepieces categories — see _AP_TO_DIGA_CATEGORY in api/v1/routes/workflows/pieces.py for the mapping.

Opciones disponibles:
AI,
COMMUNICATION,
SALES_AND_CRM,
MARKETING,
PRODUCTIVITY,
COMMERCE,
DEVELOPMENT
​
auth
PieceAuthProperty · object

Auth metadata for a piece. Shape varies by type (SECRET_TEXT, BASIC_AUTH, CUSTOM_AUTH, OAUTH2, ...); nested CUSTOM_AUTH props are returned as-is under props.

​
actions
integer | null

Number of actions exposed by the piece

​
triggers
integer | null

Number of triggers exposed by the piece

​
suggestedActions
Suggestedactions · object[] | null

Populated only when filtering by suggestion_type

​
suggestedTriggers
Suggestedtriggers · object[] | null

Populated only when filtering by suggestion_type

​
projectUsage
integer | null
​
pieceType
enum<string> | null

Origin of an Activepieces piece. Mirrors AP's own PieceType (a closed, AP-validated set), so it is safe to enumerate here.

Opciones disponibles:
OFFICIAL,
CUSTOM
​
packageType
enum<string> | null

How an Activepieces piece is packaged. Mirrors AP's own PackageType (a closed, AP-validated set).

Opciones disponibles:
REGISTRY,
ARCHIVE
​
platformId
string | null
​
archiveId
string | null
​
minimumSupportedRelease
string | null
​
maximumSupportedRelease
string | null
​
tags
string[] | null
​
created
string<date-time> | null
​
updated
string<date-time> | null