# Lightdash Homepage API

**Canonical:** https://apis.io/apis/lightdash/lightdash-homepage-api/  
**Provider:** Lightdash — https://apis.io/providers/lightdash/  
**Base URL:** https://app.lightdash.cloud  
**Documentation:** https://docs.lightdash.com/api-reference/v1/introduction

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

The Homepage API from Lightdash — 17 operation(s) for homepage.

## Operations (23)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/projects/{projectUuid}/homepage` | Get resolved project homepage |
| POST | `/api/v1/projects/{projectUuid}/homepage` | Create project homepage |
| GET | `/api/v1/projects/{projectUuid}/homepage/view-as` | View homepage as |
| GET | `/api/v1/projects/{projectUuid}/homepage/builder` | Get project homepage for builder |
| GET | `/api/v1/projects/{projectUuid}/homepage/link-metadata` | Get homepage link metadata |
| GET | `/api/v1/projects/{projectUuid}/homepage/recently-viewed` | Get homepage recently viewed |
| GET | `/api/v1/projects/{projectUuid}/homepage/assignments` | Get homepage assignments |
| PATCH | `/api/v1/projects/{projectUuid}/homepage/group-priorities` | Update homepage group priorities |
| GET | `/api/v1/projects/{projectUuid}/homepage/list` | List project homepages |
| PATCH | `/api/v1/projects/{projectUuid}/homepage/{homepageUuid}` | Update project homepage draft |
| DELETE | `/api/v1/projects/{projectUuid}/homepage/{homepageUuid}` | Delete project homepage |
| POST | `/api/v1/projects/{projectUuid}/homepage/{homepageUuid}/discard-draft` | Discard project homepage draft |
| POST | `/api/v1/projects/{projectUuid}/homepage/{homepageUuid}/publish` | Publish project homepage |
| GET | `/api/v1/projects/{projectUuid}/announcements` | List project announcements |
| POST | `/api/v1/projects/{projectUuid}/announcements` | Create project announcement |
| PATCH | `/api/v1/projects/{projectUuid}/announcements/{announcementUuid}` | Update project announcement |
| DELETE | `/api/v1/projects/{projectUuid}/announcements/{announcementUuid}` | Delete project announcement |
| POST | `/api/v1/projects/{projectUuid}/announcements/images` | Upload project announcement image |
| GET | `/api/v1/org/homepage-settings` | Get organization homepage settings |
| PATCH | `/api/v1/org/homepage-settings` | Update organization homepage settings |
| GET | `/api/v1/ee/homepage/recommended-action-skips` | List homepage recommended action skips |
| POST | `/api/v1/ee/homepage/recommended-action-skips` | Skip homepage recommended action |
| DELETE | `/api/v1/ee/homepage/recommended-action-skips/{actionKey}` | Unskip homepage recommended action |

## Machine-readable artifacts (12)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/openapi/lightdash-homepage-api-openapi.yml
- **Documentation** — https://docs.lightdash.com/api-reference/v1/introduction
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-project.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-dashboard.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-chartsummary.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-space.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-scimuser.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-serviceaccount.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-schedulerandtargets.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-schema/lightdash-apierrorpayload.json
- **Vocabulary** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/vocabulary/lightdash-vocabulary.yml
- **JSONLDContext** — https://raw.githubusercontent.com/api-evangelist/lightdash/refs/heads/main/json-ld/lightdash-context.jsonld

## Other Lightdash APIs (12)

- [Lightdash Bulk action API](https://apis.io/apis/lightdash/lightdash-bulk-action-api/)
- [Lightdash Catalog API](https://apis.io/apis/lightdash/lightdash-catalog-api/)
- [Lightdash Charts API](https://apis.io/apis/lightdash/lightdash-charts-api/)
- [Lightdash Comments API](https://apis.io/apis/lightdash/lightdash-comments-api/)
- [Lightdash Content API](https://apis.io/apis/lightdash/lightdash-content-api/)
- [Lightdash Custom Roles API](https://apis.io/apis/lightdash/lightdash-custom-roles-api/)
- [Lightdash Dashboards API](https://apis.io/apis/lightdash/lightdash-dashboards-api/)
- [Lightdash Explorer API](https://apis.io/apis/lightdash/lightdash-explorer-api/)
- [Lightdash Exploring API](https://apis.io/apis/lightdash/lightdash-exploring-api/)
- [Lightdash Exports API](https://apis.io/apis/lightdash/lightdash-exports-api/)
- [Lightdash Feature Flag API](https://apis.io/apis/lightdash/lightdash-feature-flag-api/)
- [Lightdash Files API](https://apis.io/apis/lightdash/lightdash-files-api/)

## Tags

Homepage

---

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