# gohighlevel/highlevel-api-docs architecture

> Architecture diagram of the GitHub repository gohighlevel/highlevel-api-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gohighlevel/highlevel-api-docs
- Repository: https://github.com/gohighlevel/highlevel-api-docs

## Overview

This repository is the source for GoHighLevel’s public API V2 documentation, not an API implementation. The principal workflow is a developer consulting the documentation to understand API endpoints and integrate with HighLevel. Its content is organized into API catalogs, authentication and marketplace guidance, and webhook-event references. The README describes endpoint details, examples, and errors, while the tree identifies V2/V3 catalogs and supporting schema files. Source excerpts are limited to the README and package metadata, so relationships between documentation sections are not inferred.

Main entry points: [`README.md`](https://github.com/gohighlevel/highlevel-api-docs/blob/main/README.md) (Public API docs)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalogs["API catalogs"]
  node_v2catalog["V2 API catalog"]
  node_v3catalog["V3 API catalog"]
end

subgraph group_guidance["Integration guidance"]
  node_oauthguides["OAuth guidance"]
  node_marketplaceguides["Marketplace guidance"]
end

subgraph group_events["Webhook events"]
  node_webhookrefs["Webhook references"]
end

subgraph group_schemas["Shared schemas"]
  node_commonv2["Common schemas"]
  node_commonv3["V3 common schemas"]
  node_models["Data models"]
end

node_developer(("API developer"))
node_publicdocs["Public API docs<br/>[README.md]"]

node_developer -->|"consults"| node_publicdocs

click node_publicdocs "https://github.com/gohighlevel/highlevel-api-docs/blob/main/README.md"
click node_v2catalog "https://github.com/gohighlevel/highlevel-api-docs/tree/main/apps"
click node_v3catalog "https://github.com/gohighlevel/highlevel-api-docs/tree/main/apps/v3"
click node_oauthguides "https://github.com/gohighlevel/highlevel-api-docs/tree/main/docs/oauth"
click node_marketplaceguides "https://github.com/gohighlevel/highlevel-api-docs/tree/main/docs/marketplace%20modules"
click node_webhookrefs "https://github.com/gohighlevel/highlevel-api-docs/tree/main/docs/webhook%20events"
click node_commonv2 "https://github.com/gohighlevel/highlevel-api-docs/blob/main/common/common-schemas.json"
click node_commonv3 "https://github.com/gohighlevel/highlevel-api-docs/blob/main/apps/v3/common/common-schemas.json"
click node_models "https://github.com/gohighlevel/highlevel-api-docs/tree/main/models"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_v2catalog,node_v3catalog toneBlue
class node_oauthguides,node_marketplaceguides toneAmber
class node_webhookrefs,node_developer,node_publicdocs toneMint
class node_commonv2,node_commonv3,node_models toneRose
```

## Components

### API catalogs

- [V2 API catalog](https://github.com/gohighlevel/highlevel-api-docs/tree/main/apps): `apps`
- [V3 API catalog](https://github.com/gohighlevel/highlevel-api-docs/tree/main/apps/v3): `apps/v3`

### Integration guidance

- [OAuth guidance](https://github.com/gohighlevel/highlevel-api-docs/tree/main/docs/oauth): `docs/oauth`
- [Marketplace guidance](https://github.com/gohighlevel/highlevel-api-docs/tree/main/docs/marketplace%20modules): `docs/marketplace modules`

### Webhook events

- [Webhook references](https://github.com/gohighlevel/highlevel-api-docs/tree/main/docs/webhook%20events): `docs/webhook events`

### Shared schemas

- [Common schemas](https://github.com/gohighlevel/highlevel-api-docs/blob/main/common/common-schemas.json): `common/common-schemas.json`
- [V3 common schemas](https://github.com/gohighlevel/highlevel-api-docs/blob/main/apps/v3/common/common-schemas.json): `apps/v3/common/common-schemas.json`
- [Data models](https://github.com/gohighlevel/highlevel-api-docs/tree/main/models): `models`

### Other components

- **API developer**
- [Public API docs](https://github.com/gohighlevel/highlevel-api-docs/blob/main/README.md): `README.md`

## Connections

- API developer → Public API docs: consults (evidence: `README.md`)
