Get a table template | Activepieces Management Octri Preview

1 parameter

idstringrequired

The 21-character alphanumeric identifier of the table to export as a template.

1 status code

200Returns the table template, including its name, type, summary, description, tags, author, categories, pieces, status, and any included flows and tables.

authorstringrequired

blogUrlstringoptional

categoriesarray<string>required

descriptionstringrequired

flowsarray<object>optional

metadataobjectoptional

namestringrequired

piecesarray<string>required

statusstringrequired

Allowed:PUBLISHEDARCHIVED

summarystringrequired

tablesarray<object>optional

tagsarray<object>required

typestringrequired

Allowed:OFFICIALSHAREDCUSTOM

Error handling

The id path parameter must be a 21-character alphanumeric identifier for an existing table.

import os

from activepieces_management_octri_preview_sdk import ClientConfig, ClientAuthConfig, ActivepiecesDocumentationUnofficialOctriFullPreview

config = ClientConfig(
    base_url="https://cloud.activepieces.com/api",
    auth=ClientAuthConfig(api_key=os.environ["API_TOKEN"]),
)
client = ActivepiecesDocumentationUnofficialOctriFullPreview(config)

result = client.tables.list_template2(id="9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21")

{
  "author": "example_value",
  "blogUrl": "https://example.com",
  "categories": [
    "example_value"
  ],
  "description": "Example description",
  "flows": [
    {
      "description": "Example description",
      "displayName": "Example Name",
      "notes": [
        {
          "color": "orange",
          "content": "example_value",
          "createdAt": "example_value",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "ownerId": "550e8400-e29b-41d4-a716-446655440000",
          "position": {
            "x": 1,
            "y": 1
          },
          "size": {
            "height": 1,
            "width": 1
          },
          "updatedAt": "2026-01-15T09:00:00Z"
        }
      ],
      "schemaVersion": "example_value",
      "trigger": {
        "displayName": "Example Name",
        "lastUpdatedDate": "2026-01-15T09:00:00Z",
        "name": "Example Name",
        "nextAction": "example_value",
        "settings": {
          "customLogoUrl": "https://example.com",
          "pieceName": "Example Name",
          "pieceVersion": "example_value",
          "sampleData": {
            "lastTestDate": null,
            "sampleDataFileId": null,
            "sampleDataInputFileId": null
          },
          "triggerName": "Example Name"
        },
        "type": "PIECE_TRIGGER",
        "valid": true
      },
      "valid": true
    }
  ],
  "name": "Example Name",
  "pieces": [
    "example_value"
  ],
  "status": "PUBLISHED",
  "summary": "example_value",
  "tables": [
    {
      "data": {
        "rows": [
          [
            null
          ]
        ],
        "type": "CSV"
      },
      "externalId": "550e8400-e29b-41d4-a716-446655440000",
      "fields": [
        {
          "data": {
            "options": null
          },
          "externalId": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Example Name",
          "type": "standard"
        }
      ],
      "name": "Example Name",
      "status": "active",
      "trigger": "example_value"
    }
  ],
  "tags": [
    {
      "color": "#6366f1",
      "icon": "example_value",
      "title": "Example Title"
    }
  ],
  "type": "OFFICIAL"
}

Request

Response

Errors