--- title: "List of Catalog Integrations" method: GET path: "/tableflow/v1/catalog-integrations" tags: ["Catalog Integrations (tableflow/v1)"] --- # List of Catalog Integrations `GET /tableflow/v1/catalog-integrations` [![General Availability](https://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy) Retrieve a sorted, filtered, paginated list of all catalog integrations. ## Query parameters - `environment` string, required — Filter a collection by a string search - `spec.kafka_cluster` string, required — Filter a collection by a string search - `page_size` integer - `page_token` string ## Response `200` Catalog Integration. - object — A Catalog Integration represents configuration related to a catalog integration ## The Catalog Integrations Model - `api_version` 'tableflow/v1', required — APIVersion defines the schema version of this representation of a resource. - `kind` 'CatalogIntegrationList', required — Kind defines the object this REST resource represents. - `metadata` object, required — ListMeta describes metadata that resource collections may have - `first` string, uri, nullable — A link to the first page of results. If a response does not contain a first link, then direct navigation to the first page is not supported. - `last` string, uri, nullable — A link to the last page of results. If a response does not contain a last link, then direct navigation to the last page is not supported. - `prev` string, uri, nullable — A link to the previous page of results. If a response does not contain a prev link, then either there is no previous data or backwards traversal through the result set is not supported. - `next` string, uri, nullable — A link to the next page of results. If a response does not contain a next link, then there is no more data available. - `total_size` integer — Number of records in the full result set. This response may be paginated and have a smaller number of records. - `data` object[], required — A data property that contains an array of resource items. Each entry in the array is a separate resource. - `api_version` 'tableflow/v1' — APIVersion defines the schema version of this representation of a resource. - `kind` 'CatalogIntegration' — Kind defines the object this REST resource represents. - `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space"). - `metadata` object, required — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time - `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name - `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC. - `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC. - `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC. - `spec` object, required — The desired state of the Catalog Integration - `display_name` string, required — The name of the catalog integration - `suspended` boolean — Indicates whether the Catalog Integration should be suspended. The API allows setting it only to `false` i.e., to resume the Catalog Integration. Pausing the Catalog Integration on-demand is not currently supported. - `config` union, required — The integration config - object — The catalog integration Glue connection config. - `kind` 'AwsGlue', required — The type of the catalog integration. - `provider_integration_id` string, required — The provider integration id. - `custom_database` string — The custom database name to use in AWS Glue. - object — The catalog integration connection config for Snowflake Open Catalog. - `kind` 'Snowflake', required — The type of the catalog integration. - `endpoint` string, required — The catalog integration connection endpoint for Snowflake Open Catalog. - `client_id` string, required — The client ID of the catalog integration. - `client_secret` string, required — The client secret of the catalog integration. - `warehouse` string, required — Warehouse name of the Snowflake Open Catalog. - `allowed_scope` string, required — Allowed scope of the Snowflake Open Catalog. - `custom_namespace` string — The custom namespace to use in Snowflake Open Catalog. - object — The catalog integration connection config for Unity Catalog. - `kind` 'Unity', required — The type of the catalog integration. - `workspace_endpoint` string, required — The Databricks workspace URL associated with the Unity Catalog. - `catalog_name` string, required — The name of the catalog within Unity Catalog. - `client_id` string, required — The OAuth client ID used to authenticate with the Unity Catalog. - `client_secret` string, required — The OAuth client secret used for authentication with the Unity Catalog. - `custom_schema` string — The custom schema name to use in Unity Catalog. - `environment` object, required — The environment to which the target Kafka cluster belongs. - `id` string, required — ID of the referred resource - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `kafka_cluster` object, required — The kafka cluster of the topic for which Tableflow is enabled - `id` string, required — ID of the referred resource - `environment` string — Environment of the referred resource, if env-scoped - `related` string, uri, required — API URL for accessing or modifying the referred object - `resource_name` string, uri, required — CRN reference to the referred resource - `status` TableflowV1CatalogIntegrationStatus — The status of the Catalog Integration - `phase` string — The lifecycle phase of the catalog integration: PENDING: sync to catalog integration is pending; CONNECTED: catalog integration is connected and syncing; FAILED: catalog integration failed. - `error_message` string — Displayable error message if catalog integration is in a failed state. - `last_sync_at` string — The date and time at which the catalog was last synced. It is represented in RFC3339 format and is in UTC. ## Other responses - `400` — Bad Request - `401` — The request lacks valid authentication credentials for this resource. - `403` — The access credentials were considered insufficient to grant access - `429` — Rate Limit Exceeded - `500` — Oops, something went wrong! --- [API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)