Skip to main content
GET
Get piece details

Parámetros de ruta

piece_name
string
requerido

Respuesta

Successful Response

Full piece metadata returned by the detail endpoint, including the input property schema for every action and trigger.

id
string | null

Unique piece ID

name
string | null
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
Actions · object | null
triggers
Triggers · object | null
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