Infoworks

Infoworks Table Groups API

The Table Groups API from Infoworks — 5 operation(s) for table groups.

GitHub OpenAPI

Operations 8

POST /sources/{source_id}/table-groups Add a `Table Group`.
GET /sources/{source_id}/table-groups Gets `Table Group` list.
GET /sources/{source_id}/table-groups/{table_group_id} Gets `Table Group` object for given id.
PUT /sources/{source_id}/table-groups/{table_group_id} Update `Table Group` object for given id.
DELETE /sources/{source_id}/table-groups/{table_group_id}
POST /sources/{source_id}/table-groups/{table_group_id}/configurations This will Configure particular `Table Group` with `tableGroupId`.
GET /sources/{source_id}/table-groups/{table_group_id}/audit-logs This will fetch array of audit logs for table group with `tableGroupId`.
GET /sources/{source_id}/tables-to-table-groups-mapping Gets `Table to Table Group` Mapping.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-table-groups-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.yml

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/infoworks-table-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

infoworks-table-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Table Groups API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Table Groups
  description: ''
paths:
  /sources/{source_id}/table-groups:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    post:
      security:
      - BearerAuth: []
      tags:
      - Table Groups
      summary: Add a `Table Group`.
      description: Add a `Table Group`.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  id:
                    type: string
                    example: e77850ad5127a2d7dab870ff
              - type: object
                properties:
                  source:
                    type: string
                    example: e77850ad5127a2d7dab870ff
                  environment_compute_template:
                    properties:
                      environment_compute_template_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                  name:
                    type: string
                  max_connections:
                    type: integer
                    example: 1
                  max_parallel_entities:
                    type: integer
                    example: 1
                  tables:
                    type: array
                    items:
                      properties:
                        table_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        connection_quota:
                          type: integer
                          example: 100
                        sync_type:
                          type: string
                          example: Incremental
                        state:
                          type: string
                          example: ready
                        schema_name_at_source:
                          type: string
                          example: APEX_040000
                  compute_cluster_name:
                    type: string
                    example: Persistent Cluster
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Table Group Successfully Created
                    result:
                      properties:
                        id:
                          type: string
                          example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    get:
      security:
      - BearerAuth: []
      tags:
      - Table Groups
      summary: Gets `Table Group` list.
      description: Gets `Table Group` list.
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      - name: resolve_ref
        in: query
        description: To get entity details and created by user name
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        allOf:
                        - allOf:
                          - type: object
                            properties:
                              id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                          - type: object
                            properties:
                              source:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                              environment_compute_template:
                                properties:
                                  environment_compute_template_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                              name:
                                type: string
                              max_connections:
                                type: integer
                                example: 1
                              max_parallel_entities:
                                type: integer
                                example: 1
                              tables:
                                type: array
                                items:
                                  properties:
                                    table_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                                    connection_quota:
                                      type: integer
                                      example: 100
                                    sync_type:
                                      type: string
                                      example: Incremental
                                    state:
                                      type: string
                                      example: ready
                                    schema_name_at_source:
                                      type: string
                                      example: APEX_040000
                              compute_cluster_name:
                                type: string
                                example: Persistent Cluster
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: table_group_id
      in: path
      description: Table Group Id
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Table Groups
      summary: Gets `Table Group` object for given id.
      description: Gets `Table Group` object for given id.
      parameters:
      - name: resolve_ref
        in: query
        description: To get entity details and created by user name
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                  - type: object
                    properties:
                      source:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      environment_compute_template:
                        properties:
                          environment_compute_template_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                      name:
                        type: string
                      max_connections:
                        type: integer
                        example: 1
                      max_parallel_entities:
                        type: integer
                        example: 1
                      tables:
                        type: array
                        items:
                          properties:
                            table_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            connection_quota:
                              type: integer
                              example: 100
                            sync_type:
                              type: string
                              example: Incremental
                            state:
                              type: string
                              example: ready
                            schema_name_at_source:
                              type: string
                              example: APEX_040000
                      compute_cluster_name:
                        type: string
                        example: Persistent Cluster
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
      - BearerAuth: []
      tags:
      - Table Groups
      summary: Update `Table Group` object for given id.
      description: Update `Table Group` object for given id.
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - type: object
                properties:
                  environment_compute_template:
                    properties:
                      environment_compute_template_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                  name:
                    type: string
                  max_connections:
                    type: integer
                    example: 1
                  max_parallel_entities:
                    type: integer
                    example: 1
                  query_tag:
                    type: string
                    example: table_group_tag
                  tables:
                    type: array
                    items:
                      properties:
                        table_id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
                        connection_quota:
                          type: integer
                          example: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Successfully updated table group
                      result:
                        properties:
                          id:
                            type: string
                            example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    delete:
      security:
      - BearerAuth: []
      tags:
      - Table Groups
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Table Group Successfully Created
                  result:
                    properties:
                      id:
                        type: string
                        example: c70822c5a88e5521a8153c7c
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
  /sources/{source_id}/table-groups/{table_group_id}/configurations:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    - name: table_group_id
      in: path
      description: Table Group Id
      required: true
      schema:
        type: string
    post:
      security:
      - BearerAuth: []
      tags:
      - Table Groups
      summary: This will Configure particular `Table Group` with `tableGroupId`.
      description: This will Configure particular `Table Group` with `tableGroupId`.
      requestBody:
        description: This is the JSON body of request containing configured Table group object.
        content:
          application/json:
            schema:
              type: object
              properties:
                tables:
                  type: array
                  items:
                    type: object
                    properties:
                      table_id:
                        type: string
                      connection_quota:
                        type: integer
                        example: 15
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      status:
                        type: string
                        example: success
                      id:
                        type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
        

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-table-groups-api-openapi.yml