> ## Documentation Index
> Fetch the complete documentation index at: https://docs.diga.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get piece details

> Get full metadata for a piece including triggers, actions, and their input schemas.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workflow/piece/{piece_name}
openapi: 3.1.0
info:
  title: Diga API
  version: 0.1.0
servers:
  - url: https://api.diga.io
    description: Production
security: []
paths:
  /v1/workflow/piece/{piece_name}:
    get:
      tags:
        - Workflows - Pieces
      summary: Get piece details
      description: >-
        Get full metadata for a piece including triggers, actions, and their
        input schemas.
      operationId: get_piece_v1_workflow_piece__piece_name__get
      parameters:
        - name: piece_name
          in: path
          required: true
          schema:
            type: string
            title: Piece Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PieceDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PieceDetailResponse:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: Unique piece ID
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
        logoUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Logourl
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        version:
          anyOf:
            - type: string
            - type: 'null'
          title: Version
        authors:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Authors
        categories:
          anyOf:
            - items:
                $ref: '#/components/schemas/PieceCategory'
              type: array
            - type: 'null'
          title: Categories
        auth:
          anyOf:
            - $ref: '#/components/schemas/PieceAuthProperty'
            - items:
                $ref: '#/components/schemas/PieceAuthProperty'
              type: array
            - type: 'null'
          title: Auth
        actions:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/PieceActionDefinition'
              type: object
            - type: 'null'
          title: Actions
        triggers:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/PieceTriggerDefinition'
              type: object
            - type: 'null'
          title: Triggers
        projectUsage:
          anyOf:
            - type: integer
            - type: 'null'
          title: Projectusage
        pieceType:
          anyOf:
            - $ref: '#/components/schemas/PieceType'
            - type: 'null'
        packageType:
          anyOf:
            - $ref: '#/components/schemas/PackageType'
            - type: 'null'
        platformId:
          anyOf:
            - type: string
            - type: 'null'
          title: Platformid
        archiveId:
          anyOf:
            - type: string
            - type: 'null'
          title: Archiveid
        minimumSupportedRelease:
          anyOf:
            - type: string
            - type: 'null'
          title: Minimumsupportedrelease
        maximumSupportedRelease:
          anyOf:
            - type: string
            - type: 'null'
          title: Maximumsupportedrelease
        tags:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Tags
        created:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created
        updated:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated
      additionalProperties: true
      type: object
      title: PieceDetailResponse
      description: |-
        Full piece metadata returned by the detail endpoint, including the
        input property schema for every action and trigger.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PieceCategory:
      type: string
      enum:
        - AI
        - COMMUNICATION
        - SALES_AND_CRM
        - MARKETING
        - PRODUCTIVITY
        - COMMERCE
        - DEVELOPMENT
      title: PieceCategory
      description: |-
        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.
    PieceAuthProperty:
      properties:
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: SECRET_TEXT | BASIC_AUTH | CUSTOM_AUTH | OAUTH2
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        required:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Required
        props:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Props
          description: Nested property definitions for CUSTOM_AUTH
        authUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Authurl
        tokenUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Tokenurl
        scope:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scope
        username:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Username
        password:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Password
      additionalProperties: true
      type: object
      title: PieceAuthProperty
      description: |-
        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`.
    PieceActionDefinition:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        requireAuth:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Requireauth
        props:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Props
        errorHandlingOptions:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Errorhandlingoptions
      additionalProperties: true
      type: object
      title: PieceActionDefinition
      description: Action exposed by a piece, with its input property schema.
    PieceTriggerDefinition:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        displayName:
          anyOf:
            - type: string
            - type: 'null'
          title: Displayname
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        type:
          anyOf:
            - type: string
            - type: 'null'
          title: Type
          description: POLLING | WEBHOOK | APP_WEBHOOK
        testStrategy:
          anyOf:
            - type: string
            - type: 'null'
          title: Teststrategy
        props:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Props
        sampleData:
          anyOf:
            - {}
            - type: 'null'
          title: Sampledata
        handshakeConfiguration:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Handshakeconfiguration
        renewConfiguration:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Renewconfiguration
      additionalProperties: true
      type: object
      title: PieceTriggerDefinition
      description: Trigger exposed by a piece, with its input property schema.
    PieceType:
      type: string
      enum:
        - OFFICIAL
        - CUSTOM
      title: PieceType
      description: |-
        Origin of an Activepieces piece. Mirrors AP's own ``PieceType``
        (a closed, AP-validated set), so it is safe to enumerate here.
    PackageType:
      type: string
      enum:
        - REGISTRY
        - ARCHIVE
      title: PackageType
      description: |-
        How an Activepieces piece is packaged. Mirrors AP's own
        ``PackageType`` (a closed, AP-validated set).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````