Alation

Alation Columns API

Retrieve column metadata

Documentation GitHub OpenAPI

Documentation

https://developer.alation.com

Specifications

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/openapi/alation-columns-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-data-catalog-data-source-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-data-catalog-schema-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-data-catalog-table-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-data-catalog-column-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-data-catalog-custom-field-value-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-data-catalog-data-source-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-data-catalog-schema-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-data-catalog-table-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-data-catalog-column-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-data-catalog-custom-field-value-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-lineage-dataflow-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-lineage-lineage-graph-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-lineage-dataflow-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-lineage-lineage-graph-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-governance-glossary-term-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-governance-policy-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-governance-data-quality-rule-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-governance-data-quality-score-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-governance-glossary-term-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-governance-policy-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-governance-data-quality-rule-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-governance-data-quality-score-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-search-search-result-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-search-search-results-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-search-context-request-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-schema/alation-alation-search-article-schema.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-search-search-result-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-search-search-results-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-search-context-request-structure.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/json-structure/alation-alation-search-article-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-data-catalog-data-source-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-data-catalog-schema-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-data-catalog-table-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-data-catalog-column-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-data-catalog-custom-field-value-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/graphql/alation-graphql.md

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-lineage-dataflow-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-lineage-lineage-graph-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-governance-glossary-term-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-governance-policy-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-governance-data-quality-rule-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-governance-data-quality-score-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-search-search-result-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-search-search-results-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-search-context-request-example.json

https://raw.githubusercontent.com/api-evangelist/alation/refs/heads/main/examples/alation-alation-search-article-example.json

OpenAPI Specification

openapi: 3.0.3
info:
  title: Alation Data Catalog Aggregated Context Columns API
  description: REST API for managing data sources, schemas, tables, and catalog objects in the Alation data intelligence platform. Supports metadata retrieval, custom field updates, and catalog object management.
  version: 1.0.0
  contact:
    name: Alation Developer Support
    url: https://developer.alation.com
servers:
- url: https://{instance}/integration/v2
  description: Alation instance
  variables:
    instance:
      default: your-alation-instance.com
      description: Your Alation instance hostname
security:
- BearerToken: []
tags:
- name: Columns
  description: Retrieve column metadata
paths:
  /attribute/:
    get:
      operationId: listColumns
      summary: List columns
      description: Returns columns for a given table.
      tags:
      - Columns
      parameters:
      - name: table_id
        in: query
        required: true
        description: Table ID to filter columns
        schema:
          type: integer
      - name: limit
        in: query
        schema:
          type: integer
          default: 100
      - name: skip
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: List of columns
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnList'
components:
  schemas:
    Column:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        title:
          type: string
        description:
          type: string
        data_type:
          type: string
        table_id:
          type: integer
        ds_id:
          type: integer
        is_nullable:
          type: boolean
        is_primary_key:
          type: boolean
    ColumnList:
      type: array
      items:
        $ref: '#/components/schemas/Column'
  securitySchemes:
    BearerToken:
      type: http
      scheme: bearer
      description: API access token obtained from /integration/v1/createRefreshToken/