openapi: 3.0.3
info:
  title: BigID Data Catalog API
  description: >-
    Query and export BigID's data catalog — the central inventory of objects,
    columns, and attributes discovered by BigID scans. Includes endpoints for
    metadata export, duplicate-data analysis, and column-level cluster
    similarity lookups.
  version: '1.0'
  contact:
    name: BigID Support
    url: https://developer.bigid.com/
    email: support@bigid.com
  license:
    name: BigID Terms of Service
    url: https://bigid.com/terms/
servers:
  - url: https://{deployment}.bigid.com/api/v1
    description: Customer-hosted BigID deployment.
    variables:
      deployment:
        default: tenant
tags:
  - name: Catalog
    description: Browse catalog objects.
  - name: Metadata Export
    description: Export catalog metadata.
  - name: Duplicates
    description: Discover duplicate data.
paths:
  /data-catalog:
    get:
      tags:
        - Catalog
      operationId: queryDataCatalog
      summary: Query The Data Catalog
      description: >-
        Retrieve catalog entries. Filter results with BigID's filter query
        syntax (e.g. `has_duplicates="true"` or `duplicate_id="{duplicateId}"`).
      security:
        - BearerAuth: []
      parameters:
        - name: filter
          in: query
          schema:
            type: string
          description: BigID filter expression.
        - name: limit
          in: query
          schema:
            type: integer
        - name: offset
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: Catalog entries retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogResponse'
  /data-catalog/object-details/columns:
    get:
      tags:
        - Metadata Export
      operationId: getCatalogObjectColumns
      summary: Get Catalog Object Columns
      description: Retrieve column-level metadata for catalog objects.
      security:
        - BearerAuth: []
      responses:
        '200':
          description: Column metadata retrieved.
          content:
            application/json:
              schema:
                type: object
  /data-catalog/object-details/attributes:
    get:
      tags:
        - Metadata Export
      operationId: getCatalogObjectAttributes
      summary: Get Catalog Object Attributes
      description: Retrieve attribute-level metadata (classifier hits) for unstructured catalog objects.
      security:
        - BearerAuth: []
      responses:
        '200':
          description: Attributes retrieved.
          content:
            application/json:
              schema:
                type: object
  /data-catalog/column/cluster/similar:
    get:
      tags:
        - Catalog
      operationId: listSimilarClusterColumns
      summary: List Similar Cluster Columns
      description: Get all columns for the provided cluster identifier.
      security:
        - BearerAuth: []
      parameters:
        - name: cluster_id
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Columns retrieved.
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    CatalogResponse:
      type: object
      properties:
        totalRowsCounter:
          type: integer
        results:
          type: array
          items:
            $ref: '#/components/schemas/CatalogObject'
    CatalogObject:
      type: object
      properties:
        objectName:
          type: string
        objectId:
          type: string
        type:
          type: string
        source:
          type: string
        fullObjectName:
          type: string
        attribute:
          type: array
          items:
            type: string
        has_duplicates:
          type: boolean
        duplicate_id:
          type: string
        scanner_type_group:
          type: string
        update_date:
          type: string
          format: date-time