# Collate Tables API

**Canonical:** https://apis.io/apis/collate/collate-tables-api/  
**Provider:** Collate — https://apis.io/providers/collate/  
**Base URL:** https://sandbox.open-metadata.org/api/v1  
**Documentation:** https://docs.open-metadata.org/latest/api-reference

Collate Tables API is one of 107 APIs that [Collate](https://apis.io/providers/collate/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Tables. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

`Table` organizes data in rows and columns and is defined in a `Database Schema`.

## Operations (54)

| Method | Path | Summary |
|---|---|---|
| PUT | `/v1/tables/{id}/customMetric` | Add custom metrics |
| PUT | `/v1/tables/{id}/dataModel` | Add data modeling information to a table |
| PUT | `/v1/tables/{id}/tableProfile` | Add table profile data |
| GET | `/v1/tables/{id}/tableProfilerConfig` | Get table profile config |
| PUT | `/v1/tables/{id}/tableProfilerConfig` | Add table profile config |
| DELETE | `/v1/tables/{id}/tableProfilerConfig` | Delete table profiler config |
| PUT | `/v1/tables/{id}/followers` | Add a follower |
| PUT | `/v1/tables/{id}/joins` | Add table join information |
| GET | `/v1/tables/{id}/pipelineObservability` | Get pipeline observability data |
| PUT | `/v1/tables/{id}/pipelineObservability` | Add pipeline observability data |
| DELETE | `/v1/tables/{id}/pipelineObservability` | Delete pipeline observability data |
| GET | `/v1/tables/{id}/sampleData` | Get sample data |
| PUT | `/v1/tables/{id}/sampleData` | Add sample data |
| DELETE | `/v1/tables/{id}/sampleData` | Delete sample data |
| PUT | `/v1/tables/{id}/pipelineObservability/{pipelineFqn}` | Add or update single pipeline observability data |
| DELETE | `/v1/tables/{id}/pipelineObservability/{pipelineFqn}` | Delete single pipeline observability data |
| PUT | `/v1/tables/bulk` | Bulk create or update tables |
| GET | `/v1/tables` | List tables |
| PUT | `/v1/tables` | Create or update a table |
| POST | `/v1/tables` | Create a table |
| GET | `/v1/tables/{id}` | Get a table by Id |
| DELETE | `/v1/tables/{id}` | Delete a table by Id |
| PATCH | `/v1/tables/{id}` | Update a table |
| GET | `/v1/tables/name/{fqn}` | Get a table by fully qualified name |
| DELETE | `/v1/tables/name/{fqn}` | Delete a table by fully qualified name |
| PATCH | `/v1/tables/name/{fqn}` | Update a table by name |
| DELETE | `/v1/tables/async/{id}` | Asynchronously delete a table by Id |
| DELETE | `/v1/tables/{id}/customMetric/{columnName}/{customMetricName}` | Delete custom metric from a column |
| DELETE | `/v1/tables/{fqn}/{entityType}/{timestamp}/profile` | Delete table profile data |
| DELETE | `/v1/tables/{id}/followers/{userId}` | Remove a follower |
| DELETE | `/v1/tables/deleteStale` | Delete stale tables within a scope |
| DELETE | `/v1/tables/{id}/customMetric/{customMetricName}` | Delete custom metric from a table |
| GET | `/v1/tables/name/{name}/export` | Export table in CSV format |
| GET | `/v1/tables/name/{name}/exportAsync` | Export table in CSV format |
| GET | `/v1/tables/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/tables/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/tables/{fqn}/tableProfile/latest` | Get the latest table profile |
| GET | `/v1/tables/name/{fqn}/pipelineObservability` | Get pipeline observability data by table FQN |
| GET | `/v1/tables/{id}/columns` | Get table columns with pagination |
| GET | `/v1/tables/name/{fqn}/columns` | Get table columns with pagination by FQN |
| GET | `/v1/tables/{id}/versions/{version}` | Get a version of the table |
| PUT | `/v1/tables/name/{name}/import` | Import columns from CSV to update table (no creation allowed) |
| PUT | `/v1/tables/name/{name}/importAsync` | Import columns from CSV to update table asynchronously (no creation allowed) |
| GET | `/v1/tables/{fqn}/columnProfile` | List of column profiles |
| GET | `/v1/tables/history` | List all entity versions within a time range |
| GET | `/v1/tables/{fqn}/systemProfile` | List of system profiles |
| GET | `/v1/tables/{fqn}/tableProfile` | List of table profiles |
| GET | `/v1/tables/{id}/versions` | List table versions |
| PUT | `/v1/tables/restore` | Restore a soft deleted table |
| GET | `/v1/tables/entityRelationship` | Search Entity Relationship |
| GET | `/v1/tables/entityRelationship/{direction}` | Search entity relationship with Direction |
| GET | `/v1/tables/name/{fqn}/columns/search` | Search table columns with pagination by FQN |
| GET | `/v1/tables/{id}/columns/search` | Search table columns with pagination by ID |
| PUT | `/v1/tables/{id}/vote` | Update Vote for a Entity |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-tables-api-openapi.yml
- **Documentation** — https://docs.open-metadata.org/latest/api-reference
- **APIReference** — https://docs.open-metadata.org/latest/api-reference

## Other Collate APIs (12)

- [Collate Activity Stream API](https://apis.io/apis/collate/collate-activity-stream-api/)
- [Collate Agent Executions API](https://apis.io/apis/collate/collate-agent-executions-api/)
- [Collate AI Applications API](https://apis.io/apis/collate/collate-ai-applications-api/)
- [Collate AI Audit Reports API](https://apis.io/apis/collate/collate-ai-audit-reports-api/)
- [Collate AI Context API](https://apis.io/apis/collate/collate-ai-context-api/)
- [Collate AI Framework Controls API](https://apis.io/apis/collate/collate-ai-framework-controls-api/)
- [Collate AI Governance API](https://apis.io/apis/collate/collate-ai-governance-api/)
- [Collate AI Governance Frameworks API](https://apis.io/apis/collate/collate-ai-governance-frameworks-api/)
- [Collate AI Governance Policies API](https://apis.io/apis/collate/collate-ai-governance-policies-api/)
- [Collate Announcements API](https://apis.io/apis/collate/collate-announcements-api/)
- [Collate API Collections API](https://apis.io/apis/collate/collate-api-collections-api/)
- [Collate API Endpoint API](https://apis.io/apis/collate/collate-api-endpoint-api/)

## Tags

Tables

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/collate/collate-tables-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/collate/.