> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.jazzhq.ai/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.jazzhq.ai/_mcp/server.

# API Reference

## Docs

- [Errors](https://developers.jazzhq.ai/api-reference/errors.md): Error responses and codes returned by the JazzHQ APIs

## API Docs

- Vendor/ Customer APIs > Partner [List partners](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/partner/list-partners.md)
- Vendor/ Customer APIs > Partner [Invite a partner](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/partner/invite-partner.md)
- Vendor/ Customer APIs > Partner [List users in a partner](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/partner/list-partner-users.md)
- Vendor/ Customer APIs > Partner [Add users to a partner](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/partner/add-partner-users.md)
- Vendor/ Customer APIs > Partner [Reinvite a partner](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/partner/reinvite-partner.md)
- Vendor/ Customer APIs > Lead [List a partner's leads](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/list-leads.md)
- Vendor/ Customer APIs > Lead [Create a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/create-lead.md)
- Vendor/ Customer APIs > Lead [Get a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/get-lead.md)
- Vendor/ Customer APIs > Lead [Replace a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/replace-lead.md)
- Vendor/ Customer APIs > Lead [Update a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/update-lead.md)
- Vendor/ Customer APIs > Lead [Archive a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/archive-lead.md)
- Vendor/ Customer APIs > Lead [Approve a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/approve-lead.md)
- Vendor/ Customer APIs > Lead [Reject a lead](https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/reject-lead.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developers.jazzhq.ai/api-reference/openapi.json)
- [OpenAPI YAML](https://developers.jazzhq.ai/api-reference/openapi.yaml)


> **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.jazzhq.ai/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.jazzhq.ai/_mcp/server.

# API Reference

The JazzHQ APIs let you programmatically manage your PartnerOS and integrate partner operations into your existing systems and workflows.

Use the APIs to manage your partnership, build custom integrations, and connect PartnerOS with the tools your business already uses.

## Base URL

```
https://api.jazzhq.ai
```

## Authentication

Authenticate API requests using your JazzHQ API key. Include your API key in the `X-API-KEY` header with every request:

```
X-API-KEY: YOUR_API_KEY
```

You can generate and manage API keys from your PartnerOS account, or reach out on [Support](/support) to get one.

> **Note**
>
> Only paths under `/api/v1/` are valid for this key type. Requests to any other
> path are rejected even with a valid key.

## Responses

All API responses are returned as JSON. Successful responses include the result in the `data` field.
`{ success, message, data, timestamp }`

For error responses and error codes, see [Errors](/api-reference/errors).