# Retrieve column metadata.

Endpoint: GET /database-column-metadata
Version: 3.18.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies a descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (integer)
    The id of this column metadata.
    Example: 10

  - `items.column_name` (string)
    The name of the column.
    Example: my_column

  - `items.database_table_metadata_id` (integer)
    The id of the database table metadata that this column belongs to.
    Example: 30

  - `items.table_name` (string)
    The name of the table that this column belongs to.
    Example: profile

  - `items.rule_set_id` (string)
    The id of the rule set that this column metadata belongs to.
    Example: 4ed2357d-f1a7-410c-b951-90f0edc1a0f6

  - `items.rule_set_name` (string)
    The name of the rule set that this table metadata belongs to.
    Example: my rule set

  - `items.engine_id` (string)
    The id of the engine associated with this column.
    Example: 5ff0dab4-368c-4d57-8b61-9a09b6e80f42

  - `items.engine_name` (string)
    The name of the engine associated with this column.
    Example: my engine

  - `items.algorithm_id` (string)
    The id of the algorithm associated with this column.
    Example: 7a1b2c3d-e4f5-4a6b-8c7d-9e0f1a2b3c4d

  - `items.algorithm_name` (string)
    The name of the algorithm associated with this column.
    Example: My Secure Lookup

  - `items.data_class_id` (string)
    The id of the data class associated with this column.
    Example: 6b5c4d3e-2a1b-4c3d-5e6f-7a8b9c0d1e2f

  - `items.data_class_name` (string)
    The name of the data class associated with this column.
    Example: My Domain

  - `items.data_type` (string)
    The data type of the column.
    Example: VARCHAR

  - `items.date_format` (string)
    The format of the date stored in the column.
    Example: YYYY-MM-DD

  - `items.column_length` (integer)
    The length of the column.
    Example: 255

  - `items.is_sensitive` (boolean)
    This field indicates whether or not a column has sensitive data.

  - `items.is_profiler_writable` (boolean)
    Indicates whether this column is writable by the profiler.

  - `items.is_primary_key` (boolean)
    Indicates whether this column is a primary key.

  - `items.is_identity` (boolean)
    Indicates whether this column is an identity column.

  - `items.is_index` (boolean)
    Indicates whether this column is indexed.

  - `items.is_foreign_key` (boolean)
    Indicates whether this column is a foreign key.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.