Activepieces Tables API

The tables API from Activepieces — 8 operation(s) for tables.

Operations 10

POST /v1/tables/{id} Create tables by id #
DELETE /v1/tables/{id} Delete tables by id #
GET /v1/tables/{id} Get tables by id #
GET /v1/tables Get tables #
GET /v1/tables/{id}/template Get tables by id template #
GET /v1/tables/count Get tables count #
GET /v1/tables/{id}/export Get tables by id export #
POST /v1/tables/{id}/webhooks Create tables by id webhooks #
DELETE /v1/tables/{id}/webhooks/{webhookId} Delete tables by id webhooks by webhook id #
POST /v1/tables/{id}/clear Create tables by id clear #

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/activepieces:activepieces-tables-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

activepieces-tables-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Activepieces Documentation Tables API
  version: 0.0.0
servers:
- url: https://cloud.activepieces.com/api
  description: Production Server
tags:
- name: Tables
paths:
  /v1/tables/{id}:
    post:
      tags:
      - Tables
      description: Update a table
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                trigger:
                  type: string
                  enum:
                  - ON_NEW_RECORD
                  - ON_UPDATE_RECORD
                status:
                  type: string
                  enum:
                  - ENABLED
                  - DISABLED
                folderId:
                  anyOf:
                  - type: string
                  - type: 'null'
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create tables by id
      x-summary-source: derived
      operationId: postV1TablesById
      x-operation-id-source: derived
    delete:
      tags:
      - Tables
      description: Delete a table
      parameters:
      - schema:
          type: string
          pattern: ^[0-9a-zA-Z]{21}$
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '204':
          description: Default Response
          content:
            application/json:
              schema:
                not: {}
      summary: Delete tables by id
      x-summary-source: derived
      operationId: deleteV1TablesById
      x-operation-id-source: derived
    get:
      tags:
      - Tables
      description: Get a table by id
      parameters:
      - schema:
          type: string
          pattern: ^[0-9a-zA-Z]{21}$
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  created:
                    type: string
                  updated:
                    type: string
                  name:
                    type: string
                  folderId:
                    anyOf:
                    - type: string
                    - type: 'null'
                  projectId:
                    type: string
                  externalId:
                    type: string
                  status:
                    anyOf:
                    - type: string
                      enum:
                      - ENABLED
                      - DISABLED
                    - type: 'null'
                  trigger:
                    anyOf:
                    - type: string
                      enum:
                      - ON_NEW_RECORD
                      - ON_UPDATE_RECORD
                    - type: 'null'
                required:
                - id
                - created
                - updated
                - name
                - projectId
                - externalId
                additionalProperties: false
      summary: Get tables by id
      x-summary-source: derived
      operationId: getV1TablesById
      x-operation-id-source: derived
  /v1/tables:
    get:
      tags:
      - Tables
      description: List tables
      parameters:
      - schema:
          type: string
        in: query
        name: projectId
        required: true
      - schema:
          type: number
        in: query
        name: limit
        required: false
      - schema:
          type: string
        in: query
        name: cursor
        required: false
      - schema:
          type: string
        in: query
        name: name
        required: false
      - schema:
          type: array
          items:
            type: string
        in: query
        name: externalIds
        required: true
      - schema:
          type: string
        in: query
        name: folderId
        required: false
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        created:
                          type: string
                        updated:
                          type: string
                        name:
                          type: string
                        folderId:
                          anyOf:
                          - type: string
                          - type: 'null'
                        projectId:
                          type: string
                        externalId:
                          type: string
                        status:
                          anyOf:
                          - type: string
                            enum:
                            - ENABLED
                            - DISABLED
                          - type: 'null'
                        trigger:
                          anyOf:
                          - type: string
                            enum:
                            - ON_NEW_RECORD
                            - ON_UPDATE_RECORD
                          - type: 'null'
                      required:
                      - id
                      - created
                      - updated
                      - name
                      - projectId
                      - externalId
                      additionalProperties: false
                  next:
                    anyOf:
                    - type: string
                    - type: 'null'
                  previous:
                    anyOf:
                    - type: string
                    - type: 'null'
                required:
                - data
                additionalProperties: false
      summary: Get tables
      x-summary-source: derived
      operationId: getV1Tables
      x-operation-id-source: derived
  /v1/tables/{id}/template:
    get:
      tags:
      - Tables
      description: Export table as template
      parameters:
      - schema:
          type: string
          pattern: ^[0-9a-zA-Z]{21}$
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  type:
                    type: string
                    enum:
                    - OFFICIAL
                    - SHARED
                    - CUSTOM
                  summary:
                    type: string
                  description:
                    type: string
                  tags:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                        color:
                          type: string
                          pattern: ^#[0-9A-Fa-f]{6}$
                        icon:
                          type: string
                      required:
                      - title
                      - color
                      additionalProperties: false
                  blogUrl:
                    anyOf:
                    - type: string
                    - type: 'null'
                  metadata:
                    anyOf:
                    - type: object
                      propertyNames:
                        type: string
                      additionalProperties: {}
                    - type: 'null'
                  author:
                    type: string
                  categories:
                    type: array
                    items:
                      type: string
                  pieces:
                    type: array
                    items:
                      type: string
                  flows:
                    type: array
                    items:
                      type: object
                      properties:
                        displayName:
                          type: string
                        trigger:
                          anyOf:
                          - type: object
                            properties:
                              name:
                                type: string
                                pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
                              valid:
                                type: boolean
                              displayName:
                                type: string
                              nextAction: {}
                              lastUpdatedDate:
                                type: string
                              type:
                                type: string
                                enum:
                                - PIECE_TRIGGER
                              settings:
                                type: object
                                properties:
                                  sampleData:
                                    type: object
                                    properties:
                                      sampleDataFileId:
                                        type: string
                                      sampleDataInputFileId:
                                        type: string
                                      lastTestDate:
                                        type: string
                                    additionalProperties: false
                                  propertySettings:
                                    type: object
                                    propertyNames:
                                      type: string
                                    additionalProperties:
                                      type: object
                                      properties:
                                        type:
                                          type: string
                                          enum:
                                          - MANUAL
                                          - DYNAMIC
                                        schema: {}
                                      required:
                                      - type
                                      additionalProperties: false
                                  customLogoUrl:
                                    type: string
                                  pieceName:
                                    type: string
                                  pieceVersion:
                                    type: string
                                    pattern: ^([~^])?[0-9]+\.[0-9]+\.[0-9]+$
                                  triggerName:
                                    type: string
                                  input:
                                    type: object
                                    propertyNames:
                                      type: string
                                    additionalProperties: {}
                                required:
                                - propertySettings
                                - pieceName
                                - pieceVersion
                                - input
                                additionalProperties: false
                            required:
                            - name
                            - valid
                            - displayName
                            - lastUpdatedDate
                            - type
                            - settings
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                                pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
                              valid:
                                type: boolean
                              displayName:
                                type: string
                              nextAction: {}
                              lastUpdatedDate:
                                type: string
                              type:
                                type: string
                                enum:
                                - EMPTY
                              settings: {}
                            required:
                            - name
                            - valid
                            - displayName
                            - lastUpdatedDate
                            - type
                            - settings
                            additionalProperties: false
                        valid:
                          type: boolean
                        schemaVersion:
                          anyOf:
                          - type: string
                          - type: 'null'
                        description:
                          type: string
                        notes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              content:
                                type: string
                              ownerId:
                                anyOf:
                                - type: string
                                - type: 'null'
                              color:
                                type: string
                                enum:
                                - orange
                                - red
                                - green
                                - blue
                                - purple
                                - yellow
                              position:
                                type: object
                                properties:
                                  x:
                                    type: number
                                  y:
                                    type: number
                                required:
                                - x
                                - y
                                additionalProperties: false
                              size:
                                type: object
                                properties:
                                  width:
                                    type: number
                                  height:
                                    type: number
                                required:
                                - width
                                - height
                                additionalProperties: false
                              createdAt:
                                type: string
                              updatedAt:
                                type: string
                            required:
                            - id
                            - content
                            - color
                            - position
                            - size
                            - createdAt
                            - updatedAt
                            additionalProperties: false
                      required:
                      - displayName
                      - trigger
                      - valid
                      additionalProperties: false
                  tables:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        externalId:
                          type: string
                        fields:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              type:
                                type: string
                              data:
                                anyOf:
                                - type: object
                                  properties:
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          value:
                                            type: string
                                        required:
                                        - value
                                        additionalProperties: false
                                  required:
                                  - options
                                  additionalProperties: false
                                - type: 'null'
                              externalId:
                                type: string
                            required:
                            - name
                            - type
                            - externalId
                            additionalProperties: false
                        status:
                          anyOf:
                          - type: string
                          - type: 'null'
                        trigger:
                          anyOf:
                          - type: string
                          - type: 'null'
                        data:
                          anyOf:
                          - type: object
                            properties:
                              type:
                                type: string
                                enum:
                                - CSV
                              rows:
                                type: array
                                items:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      fieldId:
                                        type: string
                                      value:
                                        type: string
                                    required:
                                    - fieldId
                                    - value
                                    additionalProperties: false
                            required:
                            - type
                            - rows
                            additionalProperties: false
                          - type: 'null'
                      required:
                      - name
                      - externalId
                      - fields
                      additionalProperties: false
                  status:
                    type: string
                    enum:
                    - PUBLISHED
                    - ARCHIVED
                required:
                - name
                - type
                - summary
                - description
                - tags
                - author
                - categories
                - pieces
                - status
                additionalProperties: false
      summary: Get tables by id template
      x-summary-source: derived
      operationId: getV1TablesByIdTemplate
      x-operation-id-source: derived
  /v1/tables/count:
    get:
      tags:
      - Tables
      description: Count tables
      parameters:
      - schema:
          type: string
        in: query
        name: projectId
        required: true
      - schema:
          type: string
        in: query
        name: folderId
        required: false
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: number
      summary: Get tables count
      x-summary-source: derived
      operationId: getV1TablesCount
      x-operation-id-source: derived
  /v1/tables/{id}/export:
    get:
      tags:
      - Tables
      description: Export a table
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  fields:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                      - id
                      - name
                      additionalProperties: false
                  rows:
                    type: array
                    items:
                      type: object
                      propertyNames:
                        type: string
                      additionalProperties:
                        type: string
                  name:
                    type: string
                required:
                - fields
                - rows
                - name
                additionalProperties: false
      summary: Get tables by id export
      x-summary-source: derived
      operationId: getV1TablesByIdExport
      x-operation-id-source: derived
  /v1/tables/{id}/webhooks:
    post:
      tags:
      - Tables
      description: Create a table webhook
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                events:
                  type: array
                  items:
                    type: string
                    enum:
                    - RECORD_CREATED
                    - RECORD_UPDATED
                    - RECORD_DELETED
                webhookUrl:
                  type: string
                flowId:
                  type: string
              required:
              - events
              - webhookUrl
              - flowId
        required: true
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Create tables by id webhooks
      x-summary-source: derived
      operationId: postV1TablesByIdWebhooks
      x-operation-id-source: derived
  /v1/tables/{id}/webhooks/{webhookId}:
    delete:
      tags:
      - Tables
      description: Delete a table webhook
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
      - schema:
          type: string
        in: path
        name: webhookId
        required: true
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
      summary: Delete tables by id webhooks by webhook id
      x-summary-source: derived
      operationId: deleteV1TablesByIdWebhooksByWebhookId
      x-operation-id-source: derived
  /v1/tables/{id}/clear:
    post:
      tags:
      - Tables
      description: Clear all records from a table
      parameters:
      - schema:
          type: string
          pattern: ^[0-9a-zA-Z]{21}$
        in: path
        name: id
        required: true
      security:
      - apiKey: []
      responses:
        '204':
          description: Default Response
          content:
            application/json:
              schema:
                not: {}
      summary: Create tables by id clear
      x-summary-source: derived
      operationId: postV1TablesByIdClear
      x-operation-id-source: derived
components:
  securitySchemes:
    apiKey:
      type: http
      description: Use your api key generated from the admin console
      scheme: bearer
externalDocs:
  url: https://www.activepieces.com/docs
  description: Find more info here