Tables

Search table columns with pagination by ID

Search table columns by name, description, or data type with server-side pagination. This endpoint provides efficient search functionality for tables with large numbers of columns.

get/v1/tables/{id}/columns/search

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/tables/{id}/columns/search
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the table

Query parameters

qstring

Search query for column names, descriptions, or data types

limitinteger

Limit the number of columns returned (1 to 1000, default = 50)

offsetinteger

Offset for pagination (default = 0)

fieldsstring
Example:tags,customMetrics

Fields requested in the returned columns

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

sortBy'name' | 'ordinalPosition'

Sort columns by field. Supported values: 'name' (default), 'ordinalPosition'

sortOrder'asc' | 'desc'

Sort order. Supported values: 'asc' (default), 'desc'

tagsstring

Filter by classification tags at column level (comma-separated tag FQNs)

glossaryTermsstring

Filter by glossary terms at column level (comma-separated glossary term FQNs)

Response

List of matching table columns

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.