# Hoko API

Use the Hoko API to create and update links, organize campaign metadata, read click analytics, and record lead or sale conversions.

## Authentication

Send a scoped API key in the Authorization header: `Authorization: Bearer <API_KEY>`.

## Machine-Readable Resources

- OpenAPI: https://hoko.to/openapi.json
- MCP endpoint: https://hoko.to/mcp
- Full API context: https://hoko.to/api/llms-full.txt
- API reference docs: https://hoko.to/docs/llms.txt

## Endpoint Inventory

| Method | Path | Scope | Purpose |
| --- | --- | --- | --- |
| GET | /api/links | linksRead | List links by id, externalId, tenantId, partnerId, and pagination parameters. |
| POST | /api/links | linksWrite | Create one or more short links. |
| PUT | /api/links | linksWrite | Create or update links; entries with id update, entries without id insert. |
| DELETE | /api/links | linksWrite | Soft-delete one or more links by UUID. |
| GET | /api/collections | collectionsRead | List collections by id with pagination. |
| POST/PUT/DELETE | /api/collections | collectionsWrite | Create, upsert, or soft-delete collections. |
| GET | /api/tags | tagsRead | List tags by id with pagination. |
| POST/PUT/DELETE | /api/tags | tagsWrite | Create, upsert, or delete tags. |
| GET | /api/partners | partnersRead | List partners by id with pagination. |
| POST/PUT/DELETE | /api/partners | partnersWrite | Create, upsert, or soft-delete partners. |
| GET | /api/customers | customersRead | List customers by id or externalId with pagination. |
| GET | /api/analytics | analyticsRead | List click analytics by linkId, partnerId, startDate, endDate, and pagination parameters. |
| POST | /api/track/lead | conversionsWrite | Record a lead conversion and upsert the customer. |
| POST | /api/track/sale | conversionsWrite | Record a sale conversion and upsert the customer. |