> ## Documentation Index
> Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Journeybee API

> Build integrations with the Journeybee PRM platform

# Journeybee API

Build integrations with the Journeybee Partner Relationship Management platform. Manage partners, contacts, deals, and more programmatically.

## Quick start

1. Get your API key from **Settings > API Keys** in the [Journeybee dashboard](https://app.journeybee.io)
2. Install the [`@journeybee/sdk`](https://www.npmjs.com/package/@journeybee/sdk) package and make your first request:

```bash theme={null}
npm install @journeybee/sdk
```

```typescript theme={null}
import { client, listPartners } from "@journeybee/sdk";

client.setConfig({
  baseUrl: "https://api.journeybee.io/v1",
  auth: "YOUR_API_KEY",
});

const { data } = await listPartners();
```

Or use the API directly:

```bash theme={null}
curl https://api.journeybee.io/v1/partners \
  -H "Authorization: Bearer YOUR_API_KEY"
```

3. Explore the [API Reference](apis/openapi.json) for all available endpoints

## What you can do

* **Manage partners** — Create, update, and query partnerships with stages, tiers, categories, and tags
* **Track leads and deals** — Full pipeline management with commissions and payments
* **Track contacts** — Add and manage contacts for each partner
* **Build learning content** — Create resources with content blocks, certifications with curricula, and track enrollments
* **Build partner portal rooms** — Create custom portal pages with text, video, action bars, goals, and more
* **Organize with custom fields** — Define custom fields and set values per entity
* **Manage tasks** — Create, assign, and track tasks across leads and deals
* **Configure settings** — Manage pipeline stages, tiers, categories, tags, and custom field definitions
* **Connect AI assistants** — Use the [MCP server](guides/mcp.md) to let Claude manage your data

## Base URL

```
https://api.journeybee.io/v1
```

## Next steps

* [Authentication](guides/authentication.md) — How to authenticate requests
* [TypeScript SDK](guides/sdk.md) — Install and use the typed SDK
* [MCP Server](guides/mcp.md) — Connect AI assistants to Journeybee
* [Embedding lead forms](guides/embedding-forms.md) — Drop a lead-capture form on any site with one script tag
* [Embedding the partner portal](guides/embedding-portal.md) — Embed the authenticated partner portal in your app
* [Pagination](guides/pagination.md) — Navigating paginated results
* [Error handling](guides/errors.md) — Understanding error responses
* [API Reference](apis/openapi.json) — Full endpoint documentation