# Foundational Lineage API

**Canonical:** https://apis.io/apis/foundational/foundational-lineage-api/  
**Provider:** Foundational — https://apis.io/providers/foundational/  
**Base URL:** /api/v1  
**Documentation:** https://docs.foundational.io/en/articles/10067204-get-started-with-the-lineage-api.md

Foundational Lineage API is one of 6 APIs that [Foundational](https://apis.io/providers/foundational/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Lineage. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 6 JSON Schemas.

The Lineage API from Foundational — 14 operation(s) for lineage.

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| GET | `/lineage/search` | Search for entities by various filters |
| GET | `/lineage/dashboards/usage-ranking` | Rank all dashboards in the org by recorded usage |
| GET | `/lineage/pr/issues/diff` | Get pull request lineage diff metadata |
| GET | `/lineage/pr/issues` | Get pull request lineage issues |
| GET | `/lineage/entity/{entity_id}` | Get an entity and its downstream/upstream dependencies |
| GET | `/lineage/entity/{entity_id}/triggers` | What does an update of this entity trigger? |
| GET | `/lineage/entity/{entity_id}/triggered-by` | What triggers this operation? What runs before it (derived)? |
| GET | `/lineage/edge/{source_id}/{dest_id}/{edge_type}/provenance` | Explain this lineage edge: the application path that carried the data |
| GET | `/lineage/entity/{entity_id}/neighbors` | Upstream/downstream neighbors of this entity (application graph) |
| POST | `/lineage/entity/{entity_id}/tags` | Add or edit custom tags on an entity |
| DELETE | `/lineage/entity/{entity_id}/tags/{tag_name}` | Remove a custom tag from an entity |
| PUT | `/lineage/entity/{entity_id}/certification` | Set an entity's certification |
| DELETE | `/lineage/entity/{entity_id}/certification` | Clear an entity's certification |
| PUT | `/lineage/entity/{entity_id}/description` | Set an entity's description |
| DELETE | `/lineage/entity/{entity_id}/description` | Clear an entity's manual description |
| GET | `/lineage/entity/{entity_id}/{direction}` | Get an entity's downstream/upstream dependencies |

## Machine-readable artifacts (9)

- **OpenAPI** — https://artifacts.apis.io/foundational/openapi/foundational-lineage-api-openapi.yml
- **Documentation** — https://docs.foundational.io/en/articles/10067204-get-started-with-the-lineage-api.md
- **APIReference** — https://api.foundational.io/api/v1/docs
- **JSONSchema** — https://artifacts.apis.io/foundational/json-schema/foundational-lineage-entity-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/foundational/json-schema/foundational-dashboard-usage-ranking-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/foundational/json-schema/foundational-lineage-entities-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/foundational/json-schema/foundational-app-graph-neighbors-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/foundational/json-schema/foundational-edge-provenance-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/foundational/json-schema/foundational-public-policy-response-schema.json

## Other Foundational APIs (5)

- [Foundational Auth API](https://apis.io/apis/foundational/foundational-auth-api/)
- [Foundational Manual Lineage API](https://apis.io/apis/foundational/foundational-manual-lineage-api/)
- [Foundational Monitors API](https://apis.io/apis/foundational/foundational-monitors-api/)
- [Foundational Onboarding API](https://apis.io/apis/foundational/foundational-onboarding-api/)
- [Foundational Policies API](https://apis.io/apis/foundational/foundational-policies-api/)

## Tags

Lineage

---

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