# Collate Metadata API

**Canonical:** https://apis.io/apis/collate/collate-metadata-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 Metadata 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 Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

These APIs are for managing custom property definitions in OpenMetadata. Use these APIs to create custom properties with predefined data types (String, Integer, Date, etc.) that extend entity metadata. Note: This does not support creating new custom data types - only custom properties using existing OpenMetadata data types.

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/metadata/types/{id}` | Get a type |
| PUT | `/v1/metadata/types/{id}` | Add or update a Property to an entity |
| DELETE | `/v1/metadata/types/{id}` | Delete a type by id |
| PATCH | `/v1/metadata/types/{id}` | Update a type |
| GET | `/v1/metadata/types` | List types |
| PUT | `/v1/metadata/types` | Create or update a type |
| POST | `/v1/metadata/types` | Create a custom property definition |
| GET | `/v1/metadata/types/name/{name}` | Get a type by name |
| DELETE | `/v1/metadata/types/name/{name}` | Delete a type by name |
| DELETE | `/v1/metadata/types/async/{id}` | Asynchronously delete a type by id |
| GET | `/v1/metadata/types/{id}/context` | Get the AI context for an entity by id |
| GET | `/v1/metadata/types/name/{fqn}/context` | Get the AI context for an entity by fully qualified name |
| GET | `/v1/metadata/types/customProperties` | Get all custom properties by entity type |
| GET | `/v1/metadata/types/name/{entityType}/customProperties` | Get custom properties for an entity type |
| GET | `/v1/metadata/types/fields/{entityType}` | Get entity type fields |
| GET | `/v1/metadata/types/{id}/versions/{version}` | Get a version of the types |
| GET | `/v1/metadata/types/history` | List all entity versions within a time range |
| GET | `/v1/metadata/types/{id}/versions` | List type versions |
| PATCH | `/v1/metadata/types/name/{fqn}` | Update a type using name |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/collate/refs/heads/main/openapi/collate-metadata-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

Metadata

---

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